{"id":22490124,"url":"https://github.com/platform-kit/docs","last_synced_at":"2025-08-02T22:32:19.419Z","repository":{"id":49853539,"uuid":"518376872","full_name":"platform-kit/docs","owner":"platform-kit","description":"Static documentation generator \u0026 PWA.","archived":false,"fork":false,"pushed_at":"2022-08-02T06:31:10.000Z","size":16229,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-02T23:47:14.756Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/platform-kit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-27T08:40:53.000Z","updated_at":"2022-07-27T08:41:01.000Z","dependencies_parsed_at":"2022-09-09T11:02:47.378Z","dependency_job_id":null,"html_url":"https://github.com/platform-kit/docs","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/platform-kit%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/platform-kit%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/platform-kit%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/platform-kit%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/platform-kit","download_url":"https://codeload.github.com/platform-kit/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228500832,"owners_count":17930140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-06T17:21:50.306Z","updated_at":"2024-12-06T17:24:22.339Z","avatar_url":"https://github.com/platform-kit.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003ePlatformKit Docs\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\nStatic Documentation Generator\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\nSearch, analytics, pdf export, \u0026 offline mode.\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/platform-kit/docs/master/assets/images/screenshot.png\" style=\"border-radius:4px; margin:auto;max-width:300px;\"  width=\"400\"/\u003e\n\u003c/div\u003e\n\n\n**Built with:** \u003cbr\u003e\n\n\u003cp float=\"left\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Node.js-ebf5fb?style=for-the-badge\u0026logo=nodedotjs\"/\u003e\n\u003cimg src=\"https://img.shields.io/badge/Vue.js-ebf5fb?style=for-the-badge\u0026logo=vuedotjs\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Nuxt.js-ebf5fb?style=for-the-badge\u0026logo=nuxt.js\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Bootstrap-ebf5fb?style=for-the-badge\u0026logo=bootstrap\" /\u003e\n\u003c/p\u003e\n\n**Deploy with:** \u003cbr\u003e \n\u003cp float=\"left\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Heroku-430098?style=for-the-badge\u0026logo=heroku\u0026logoColor=white\"/\u003e \u003cimg src=\"https://img.shields.io/badge/Digital_Ocean-0080FF?style=for-the-badge\u0026logo=DigitalOcean\u0026logoColor=white\" /\u003e \u003cimg src=\"https://img.shields.io/badge/Render-46E3B7?style=for-the-badge\u0026logo=Render\u0026logoColor=white\"/\u003e \n\u003c/p\u003e\n\n**License:** \u003cbr\u003e \u003cimg src=\"https://img.shields.io/badge/License-000000?style=for-the-badge\u0026logo=git\"/\u003e \u003cimg src=\"https://img.shields.io/badge/MIT-222?style=for-the-badge\u0026logoColor=white\"/\u003e\n\n## Features\n\n- Generate beautiful, searchable docs from [Markdown](https://www.markdownguide.org) files\n- Frontmatter support (title, description, git repo, website)\n- Progressive Web App (works offline)\n- Automated reading time estimates\n- Code syntax highlighting\n- Zero-config analytics\n- Emoji based feedback\n- Export docs as PDF\n\n\n## Local Development\n\nClone the project\n\n```bash\n  git clone https://github.com/platform-kit/docs pk-docs\n```\n\nGo to the project directory\n\n```bash\n  cd pk-docs\n```\n\nInstall dependencies\n\n```bash\n  npm install \n```\n\nStart the server\n\n```bash\n  npm run dev\n```\n\nA local instance is now running at `https://localhost:3000`\n\n### Configuration\n\nBefore use, you will need to add the following environment variables to your .env file\n\n```env\nREPO=\nSITE_NAME=\nBUILD_COMMAND=\nCONTENT_DIRECTORY=\n```\n\n## Deployment\n\nTo deploy to the cloud, simply click one of the buttons below.\n\nNote: if you deploy to Netlify, you will have to provision a database manually.\n\n\u003ca href=\"https://heroku.com/deploy?template=https://github.com/platform-kit/docs\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Deploy%20to%20Heroku→-430098?style=for-the-badge\u0026logo=heroku\u0026logoColor=white\"/\u003e\u003c/a\u003e \u003ca href=\"https://cloud.digitalocean.com/apps/new?repo=https://github.com/platform-kit/docs/tree/main\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Deploy%20to%20Digital_Ocean→-0080FF?style=for-the-badge\u0026logo=DigitalOcean\u0026logoColor=white\" /\u003e \u003c/a\u003e \u003ca href=\"https://render.com/deploy?repo=https://github.com/platform-kit/docs\" target=\"_blank\"\u003e \u003cimg src=\"https://img.shields.io/badge/Deploy%20to%20Render→-46E3B7?style=for-the-badge\u0026logo=Render\u0026logoColor=fff\"/\u003e \u003c/a\u003e \n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplatform-kit%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplatform-kit%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplatform-kit%2Fdocs/lists"}