Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gorse-io/docs
Official documents for Gorse recommender system engine
https://github.com/gorse-io/docs
Last synced: about 2 months ago
JSON representation
Official documents for Gorse recommender system engine
- Host: GitHub
- URL: https://github.com/gorse-io/docs
- Owner: gorse-io
- License: cc0-1.0
- Created: 2021-04-17T11:48:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T01:32:16.000Z (2 months ago)
- Last Synced: 2024-10-24T17:11:00.080Z (2 months ago)
- Language: TypeScript
- Homepage: https://gorse.io
- Size: 15.8 MB
- Stars: 4
- Watchers: 3
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gorse Docs
[](https://app.netlify.com/sites/gorse-io/deploys)
Official documents for Gorse recommender system.
## Setup environment
This is a [VuePress](https://vuepress.vuejs.org/) project, so you need to install:
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
## Install dependencies and run
```bash
# Clone the repository
git clone [email protected]: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:
```bash
yarn docs:build
```
The static files will be available in `.vuepress/dist`.
## Localization
Welcome to translate the Gorse document into more languages on [GitLocalize](https://gitlocalize.com/repo/8172).
| Language | Progress |
| --- | --- |
| Chinese | [](https://gitlocalize.com/repo/8172/zh?utm_source=badge) |
## Acknowledgments
- The [VuePress](https://vuepress.vuejs.org/) version of documents is contributed by [@andresribeiro](https://github.com/andresribeiro).
- The theme of VuePress is [vuepress-theme-hope](https://vuepress-theme-hope.github.io/v2/).