https://github.com/growilabs/growi-docs
:anchor: GROWI documentation repository
https://github.com/growilabs/growi-docs
documentation growi markdown vuepress
Last synced: about 1 year ago
JSON representation
:anchor: GROWI documentation repository
- Host: GitHub
- URL: https://github.com/growilabs/growi-docs
- Owner: growilabs
- License: mit
- Created: 2018-07-08T21:09:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T07:24:10.000Z (about 1 year ago)
- Last Synced: 2025-04-01T07:39:05.934Z (about 1 year ago)
- Topics: documentation, growi, markdown, vuepress
- Language: Dockerfile
- Homepage: https://docs.growi.org
- Size: 187 MB
- Stars: 31
- Watchers: 10
- Forks: 86
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# growi-docs
[](https://github.com/growilabs/growi-docs/actions/workflows/deploy.yml)
## Requirements
- Node.js v14 or v16
- Yarn v1.22
## How to start
``` bash
yarn
# Start dev server (docs-growi-org)
yarn start
# Or start dev server (help-growi-cloud)
yarn help-growi-cloud:dev
```
Then, access to the URL that VuePress will print like below.
``` bash
> VuePress dev server listening at http://localhost:8080/
```
## How to write docs
Add Markdown file to `docs` dir.
For detail, please reference [VuePress Documents](https://vuepress.vuejs.org/).
## How to write API docs
``` bash
yarn api:dev
```
### Live Server
Launch the [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
to watch the modification to the `growi` repository will be applied in realtime.
1. `yarn api:dev`
1. Right click `redoc/apivX.html` in the file tree and select "Open with Live Server".