Sider document page 🐱
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs Add administration guide Feb 21, 2019
website
.dockerignore
.gitignore
Dockerfile Move to Docusaurus Feb 6, 2019
LICENSE
README.md
docker-compose.yml
goodcheck.yml
netlify.toml
package.json Lint markdown files via remark Feb 8, 2019
yarn.lock

README.md

Sider docs

Run sider-docs in your machine

We have 2 ways to get start sider-docs application as follows:

$ cd website    # All dependencies are in website directory.
$ yarn          # Install dependencies.
$ yarn start

or

$ docker-compose up

It requires Yarn or docker-compose to run above commands.

Documentation

sider-docs is powered by Docusaurus. Thus, if you face with problems, check that documents.

Lint

To lint source files, run the following command:

$ yarn run lint