https://github.com/squirrellyjs/squirrelly-docs
The new docs website for Squirrelly v7 and v8
https://github.com/squirrellyjs/squirrelly-docs
Last synced: about 1 month ago
JSON representation
The new docs website for Squirrelly v7 and v8
- Host: GitHub
- URL: https://github.com/squirrellyjs/squirrelly-docs
- Owner: squirrellyjs
- Created: 2019-08-31T00:07:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T00:16:33.000Z (about 1 year ago)
- Last Synced: 2024-05-02T16:34:03.594Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://squirrelly.js.org
- Size: 2.96 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Squirrelly Docs Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
Note that the Version 7 docs are in the `v7` branch
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.