Static Documentation Generator

Search, analytics, pdf export, & offline mode.

Built with:

Deploy with:

License:

• Generate beautiful, searchable docs from Markdown files
• Frontmatter support (title, description, git repo, website)
• Progressive Web App (works offline)
• Automated reading time estimates
• Code syntax highlighting
• Zero-config analytics
• Emoji based feedback
• Export docs as PDF

Clone the project

  git clone https://github.com/platform-kit/docs pk-docs

Go to the project directory

  cd pk-docs

Install dependencies

  npm install 

Start the server

  npm run dev

A local instance is now running at https://localhost:3000

Before use, you will need to add the following environment variables to your .env file

REPO=
SITE_NAME=
BUILD_COMMAND=
CONTENT_DIRECTORY=

To deploy to the cloud, simply click one of the buttons below.

Note: if you deploy to Netlify, you will have to provision a database manually.