Skip to content
This repository has been archived by the owner on Dec 23, 2022. It is now read-only.

WIP New docs site #29

Merged
merged 6 commits into from
Sep 11, 2019
Merged

WIP New docs site #29

merged 6 commits into from
Sep 11, 2019

Conversation

laosb
Copy link
Contributor

@laosb laosb commented Sep 11, 2019

To build new docs, you'll need to have Node.js and Yarn installed on your system, and run:

# Install dependencies
yarn
# Run `build` in package.json
yarn build

in docs-src/.

Docs will be built into docs, where GitHub Pages treated as site root. So be sure to commit docs changes.

CI/CD is not included in this PR, so manual build is required after every docs update. yarn dev runs a local hot-reload-enabled docs server for easier debugging.

In the long run, using some 3rd-party static hosting like Netlify would be easier to release docs.

Docs engine is based on VuePress.

@MouriNaruto
Copy link
Contributor

Thanks.

@MouriNaruto MouriNaruto merged commit 6b91b1f into M2TeamArchived:master Sep 11, 2019
MouriNaruto added a commit that referenced this pull request Sep 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants