https://github.com/plausible/docs
Documentation for Plausible Analytics
https://github.com/plausible/docs
Last synced: about 1 year ago
JSON representation
Documentation for Plausible Analytics
- Host: GitHub
- URL: https://github.com/plausible/docs
- Owner: plausible
- License: cc-by-sa-4.0
- Created: 2020-06-08T14:38:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T04:42:28.000Z (about 2 years ago)
- Last Synced: 2024-05-01T10:34:05.551Z (about 2 years ago)
- Language: CSS
- Homepage: https://plausible.io/docs
- Size: 68.4 MB
- Stars: 193
- Watchers: 9
- Forks: 184
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
### Installation
```bash
npm install
```
### Local Development
```bash
npm run 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.
To run alongside [plausible/analytics](https://github.com/plausible/analytics/), also run caddy in a different terminal:
```bash
caddy run --config Caddyfile
```
Docs are served on localhost:8001/docs in that case.
### Build
```bash
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```bash
$ GIT_USER= USE_SSH=true npm run 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.