https://github.com/potts99/docs

Docs for the main site of peppermint
https://github.com/potts99/docs

documentation docusaurus2 facebook netlify peppermint reactjs

Last synced: about 2 months ago
JSON representation

Docs for the main site of peppermint

• Host: GitHub
• URL: https://github.com/potts99/docs
• Owner: potts99
• Created: 2020-12-14T22:02:07.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-02T19:38:25.000Z (almost 3 years ago)
• Last Synced: 2023-03-08T05:26:31.814Z (almost 2 years ago)
• Topics: documentation, docusaurus2, facebook, netlify, peppermint, reactjs
• Language: JavaScript
• Homepage: https://docs.peppermint.sh
• Size: 1.81 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```

$ yarn

```

### Local Development

```

$ yarn start

```

This command starts a local development server and opens 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

Using SSH:

```

$ USE_SSH=true yarn deploy

```

Not using SSH:

```

$ GIT_USER= 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.