https://github.com/growilabs/growi-docs

:anchor: GROWI documentation repository
https://github.com/growilabs/growi-docs

documentation growi markdown vuepress

Last synced: 6 days 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 (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T08:53:14.000Z (3 months ago)
• Last Synced: 2024-10-29T10:02:42.518Z (3 months ago)
• Topics: documentation, growi, markdown, vuepress
• Language: Dockerfile
• Homepage: https://docs.growi.org
• Size: 179 MB
• Stars: 31
• Watchers: 11
• Forks: 85
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# growi-docs

[![Deploy](https://github.com/growilabs/growi-docs/actions/workflows/deploy.yml/badge.svg)](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".