Skip to content

plausible/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7e11022 · Jan 16, 2025
Nov 6, 2024
Jan 16, 2025
Jan 16, 2025
Nov 19, 2024
May 27, 2024
Jun 6, 2020
Aug 22, 2024
Aug 22, 2024
Jun 16, 2021
Aug 22, 2024
Aug 22, 2024
Aug 27, 2024
Aug 27, 2024
Dec 3, 2024
Aug 23, 2024

Repository files navigation

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

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, also run caddy in a different terminal:

caddy run --config Caddyfile

Docs are served on localhost:8001/docs in that case.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

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