3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-06 10:20:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: update readme & dependencies

Browse source
This commit is contained in:
endiliey 2018-08-08 14:11:31 +08:00
parent fa02f6ef60
commit 2996e011f8
3 changed files with 8 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -2,24 +2,10 @@
📝⚡️ Transform your document (문서) to a website 📝⚡️ Transform your document (문서) to a website
# Disclaimer: # Disclaimer:
This is still a *WORK IN PROGRESS* (prototype static site generator). Expect lot of bugs :) This is still a *WORK IN PROGRESS*. Expect lot of bugs :)
# Introduction
- Each page generated is own pre-rendered static HTML.
- Once the page is loaded, ReactDOM takes over the static content and turns it into a full Single-Page Application (SPA).
# Current
- Generate page for `.md` files on `docs`
- Generate page for `.js` React files on `website/pages`
# Quick Start # Quick Start
Install with `yarn`. Check all available commands with:
```
yarn munseo --help
```
## Development Server ## Development Server
```bash ```bash
@ -30,5 +16,4 @@ yarn start # open http://localhost:3000/
```bash ```bash
yarn build # check website/build yarn build # check website/build
``` ```

6
package.json
View file

@ -8,8 +8,8 @@
}, },
"scripts": { "scripts": {
"munseo": "node bin/munseo", "munseo": "node bin/munseo",
"start": "yarn munseo start website", "start": "node bin/munseo start website",
"build": "yarn munseo build website", "build": "node bin/munseo build website",
"prettier": "prettier --config .prettierrc --write \"lib/**/*.js\" \"bin/**/*.js\" \"test/**/*.js\"", "prettier": "prettier --config .prettierrc --write \"lib/**/*.js\" \"bin/**/*.js\" \"test/**/*.js\"",
"lint": "eslint --cache \"lib/**/*.js\" \"bin/**/*.js\" \"test/**/*.js\"", "lint": "eslint --cache \"lib/**/*.js\" \"bin/**/*.js\" \"test/**/*.js\"",
"test": "jest" "test": "jest"
@ -69,7 +69,7 @@
"static-site-generator-webpack-plugin": "^3.4.1", "static-site-generator-webpack-plugin": "^3.4.1",
"webpack": "^4.16.3", "webpack": "^4.16.3",
"webpack-chain": "^4.8.0", "webpack-chain": "^4.8.0",
"webpack-nicelog": "^2.0.0", "webpack-nicelog": "^2.1.0",
"webpack-serve": "^2.0.2" "webpack-serve": "^2.0.2"
}, },
"engines": { "engines": {

6
yarn.lock
View file

@ -6799,9 +6799,9 @@ webpack-log@^1.0.1, webpack-log@^1.1.1, webpack-log@^1.1.2, webpack-log@^1.2.0:
loglevelnext "^1.0.1" loglevelnext "^1.0.1"
uuid "^3.1.0" uuid "^3.1.0"
webpack-nicelog@^2.0.0: webpack-nicelog@^2.1.0:
version "2.0.0" version "2.1.0"
resolved "https://registry.yarnpkg.com/webpack-nicelog/-/webpack-nicelog-2.0.0.tgz#7e4d68c54e7bd82adf19fde1eb3d43e767eea887" resolved "https://registry.yarnpkg.com/webpack-nicelog/-/webpack-nicelog-2.1.0.tgz#fb8d89ec1976d36122e8d407bf318eb38c094155"
dependencies: dependencies:
chalk "^2.4.1" chalk "^2.4.1"
react-dev-utils "^5.0.1" react-dev-utils "^5.0.1"