Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guess-js/guess-js.github.io

The website of Guess.js
https://github.com/guess-js/guess-js.github.io

docs guess-js ml web-performance

Last synced: about 2 months ago
JSON representation

The website of Guess.js

Awesome Lists containing this project

README

        

# Website of Guess.js

This repository contains the source code for [guessjs.com](https://guessjs.com).

## Developing

```bash
npm i -g gatsby
git clone [email protected]:guess-js/guessjs.com && cd guessjs.com
npm i
gatsby develop
```

## Deployment

For deployment, you need the `guess` repository in a sibling directory of the docs in order to generate API documentation:

```bash
git clone [email protected]:guess-js/guess
git clone [email protected]:guess-js/guessjs.com && cd guessjs.com
npm i
npm run build
git add .
git commit -am 'Publishing the docs'
git push origin master
```

## Adding a Guide

To add a guide, create a markdown file in the `content` directory. To add a link to the guide in the "Docs" page, edit `src/components/docs-layout/index.js` and add a new entry in the `renderSidebar` method.

## License

MIT