Skip to content

Commit 1a7ce77

Browse files
committed
README: Convert to markdown
pandoc --from rst --to markdown+multiline_tables --reference-links \ --reference-location=section --columns=100 README.rst --atx-headers | \ sed s/"<"/"\("/g | \ sed s/">"/"\)"/g | \ sed s/"- "/"- "/g | \ sed s/"\\\'"/"'"/g \ > tmp; mv tmp README.md
1 parent eb93986 commit 1a7ce77

File tree

2 files changed

+51
-55
lines changed

2 files changed

+51
-55
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
See also: <https://github.com/tony/react-typescript-vanilla-starter>
2+
3+
Split off of <https://github.com/tony/cv> v2 in the initial stages
4+
5+
MIT licensed. Feel free to copy, fork, etc.
6+
7+
# Summary
8+
9+
Dev server, typed webpack config, typescript, jsx, babel.
10+
11+
No SASS/SCSS/LESS. No static files. Wiring those in are highly dependent on integration.
12+
13+
# Usage
14+
15+
```bash
16+
npm install # install packages
17+
18+
npm run start # launch + hot reloading + watch file changes http://localhost:3091
19+
20+
npm run build # build to dist/
21+
```
22+
23+
## Environmental variables
24+
25+
[Webpack's environmental variables] can be passed (`--env`):
26+
27+
Launch dev server on port 3092:
28+
29+
`npm run start -- --env.devServerPort 3092`
30+
31+
`npm run start -- --env.production`
32+
33+
`npm run start -- --open` Launch browser + build + watch files, <http://localhost:3099>
34+
35+
[webpack's environmental variables]: https://webpack.js.org/guides/environment-variables/
36+
37+
# Contribution guidelines
38+
39+
Corrections: ✔️
40+
41+
Package updates: ✔️ (_please QA to verify build output / watch / reloading works_)
42+
43+
CI System: ✔️ (_get travis setup_)
44+
45+
New feature / Loader: 🚫 (_please create a fork!_)
46+
47+
# Thanks / Credits
48+
49+
- <https://github.com/microsoft/TypeScript-Vue-Starter/> (reference, tsconfig.json and placeholder
50+
Vue components only this starter is _not derived_ from it)
51+
- <https://vue-loader.vuejs.org/guide/#manual-setup>

README.rst

Lines changed: 0 additions & 55 deletions
This file was deleted.

0 commit comments

Comments
 (0)