Gorse Docs

Official documents for Gorse recommender system.

Setup environment

This is a VuePress project, so you need to install:

• Node.js
• Yarn

Install dependencies and run

# Clone the repository
git clone git@github.com:gorse-io/docs.git

# Change directory
cd docs

# Install dependencies
yarn install

# Run Gorse Docs on http://localhost:8080
yarn docs:dev

Deployment

Gorse Docs is deployed as a static website. The main branch is deployed at https://gorse.io.

You can build the static website like this:

 yarn docs:build

The static files will be available in .vuepress/dist.

Localization

Welcome to translate the Gorse document into more languages on GitLocalize.

Language	Progress
Chinese

Acknowledgments

• The VuePress version of documents is contributed by @andresribeiro.
• The theme of VuePress is vuepress-theme-hope.