https://github.com/cuttlebelle/website
The website for cuttlebelle
https://github.com/cuttlebelle/website
cuttlebelle documentation react ssr static-site-generator
Last synced: 3 days ago
JSON representation
The website for cuttlebelle
- Host: GitHub
- URL: https://github.com/cuttlebelle/website
- Owner: cuttlebelle
- License: gpl-3.0
- Created: 2017-12-06T05:22:46.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T23:25:34.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T13:18:21.906Z (over 2 years ago)
- Topics: cuttlebelle, documentation, react, ssr, static-site-generator
- Language: JavaScript
- Homepage: http://cuttlebelle.com
- Size: 2.52 MB
- Stars: 11
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Cuttlebelle documentation website
[](https://twitter.com/intent/tweet?url=https://cuttlebelle.com&hashtags=react,reactjs,static-site-generator,jsx)
=================================
**
This website was built with **[Cuttlebelle](https://github.com/cuttlebelle/cuttlebelle/)**. Please have a look at the source if you’re curious.
**
##
[Visit our website](https://cuttlebelle.com/)
[](https://cuttlebelle.com/)
## How to build the site locally
```shell
cd path/to/this/repo
npm install
npm run build
npm run docs
```
The `build` command will build the site from source. The `docs` command will build the site automatic documentation of each layout.
You can have a look at [the docs files](https://cuttlebelle.github.io/website/).
## How to work on the site
```shell
cd path/to/this/repo
npm run watch
```
This command will build the site and open a server for you and a website should open in your browser. Changes are automatically watched now.
## How to contribute
_(_ 💡 _Please look at the coding style and work with it, not against it :smile:.)_