https://github.com/platform-kit/docs
Static documentation generator & PWA.
https://github.com/platform-kit/docs
Last synced: 11 months ago
JSON representation
Static documentation generator & PWA.
- Host: GitHub
- URL: https://github.com/platform-kit/docs
- Owner: platform-kit
- Created: 2022-07-27T08:40:53.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-02T06:31:10.000Z (almost 4 years ago)
- Last Synced: 2023-03-02T23:47:14.756Z (over 3 years ago)
- Language: Vue
- Size: 15.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PlatformKit Docs
Static Documentation Generator
Search, analytics, pdf export, & offline mode.
**Built with:**
**Deploy with:**
**License:**
## Features
- Generate beautiful, searchable docs from [Markdown](https://www.markdownguide.org) 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
## Local Development
Clone the project
```bash
git clone https://github.com/platform-kit/docs pk-docs
```
Go to the project directory
```bash
cd pk-docs
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
A local instance is now running at `https://localhost:3000`
### Configuration
Before use, you will need to add the following environment variables to your .env file
```env
REPO=
SITE_NAME=
BUILD_COMMAND=
CONTENT_DIRECTORY=
```
## Deployment
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.
