https://github.com/dirtyf/docusaurus-forestry-starter
https://github.com/dirtyf/docusaurus-forestry-starter
docusaurus forestry-starter
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dirtyf/docusaurus-forestry-starter
- Owner: DirtyF
- License: mit
- Created: 2020-06-03T12:17:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T07:47:05.000Z (over 2 years ago)
- Last Synced: 2025-03-19T09:43:00.774Z (2 months ago)
- Topics: docusaurus, forestry-starter
- Language: JavaScript
- Size: 1.44 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docusaurus Forestry starter
Documentation website starter built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Content Management
This repository is ready to be imported in [Forestry](https://forestry.io), a Git-based CMS, to edit Markdown, JSON files and preview your site before saving changes.
[](https://app.forestry.io/quick-start?repo=DirtyF/docusaurus-forestry-starter&engine=other)
### 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
#### Vercel
[](https://vercel.com/import/git)
Copy-paste your Git repository URL, set build settings and click deploy ✨.
#### GitHub Pages
```
$ 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.