{"id":13615651,"url":"https://github.com/Snickdx/pwadocs","last_synced_at":"2025-04-13T21:31:16.613Z","repository":{"id":24974673,"uuid":"102903834","full_name":"Snickdx/pwadocs","owner":"Snickdx","description":"Turn your mkdocs site into a PWA","archived":false,"fork":false,"pushed_at":"2023-04-19T03:18:50.000Z","size":3913,"stargazers_count":22,"open_issues_count":5,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-07T23:39:51.066Z","etag":null,"topics":["mkdocs","mkdocs-material","mkdocs-site","pwa","service-worker","workbox"],"latest_commit_sha":null,"homepage":"https://nmendez.app/pwadocs","language":"HTML","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/Snickdx.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-09-08T20:57:02.000Z","updated_at":"2024-05-30T21:13:50.000Z","dependencies_parsed_at":"2024-01-17T00:34:58.933Z","dependency_job_id":null,"html_url":"https://github.com/Snickdx/pwadocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snickdx%2Fpwadocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snickdx%2Fpwadocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snickdx%2Fpwadocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Snickdx%2Fpwadocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Snickdx","download_url":"https://codeload.github.com/Snickdx/pwadocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248786226,"owners_count":21161419,"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":["mkdocs","mkdocs-material","mkdocs-site","pwa","service-worker","workbox"],"created_at":"2024-08-01T20:01:16.220Z","updated_at":"2025-04-13T21:31:11.594Z","avatar_url":"https://github.com/Snickdx.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# PWADocs\n\n\u003cimg src=\"install.gif\" style=\"display block; margin-left:auto; margin-right:auto; width:180px; height:300px\"\u003e\n\nA PWA wrapper for Mkdocs Material. \nThis project combines:\n* Workbox-cli for building the service worker.\n* MkDocs: Static site doc site geneator\n* Material for MkDocs: A Material theme for mkdocs\n\n[DEMO](https://nmendez.app/pwadocs)\n\n\n## Requirements\n* Python 2 or 3\n* Node. npm\n\n## Installation\nInstall python dependencies\n```\n$ pip install -r requirements.txt\n```\n\nInstall npm packages\n```\n$ npm install -g workbox-cli\n```\n\n## Configuration\n\n### Configuring the site\nTo set the app's name, description google analytics and title edit the folling directives in the mkdocs.yml file.\n\n```yaml\n# Project information\nsite_name: 'Material for MkDocs'\nsite_description: 'A Material Design theme for MkDocs'\nsite_author: 'Martin Donath'\nsite_url: 'https://squidfunk.github.io/mkdocs-material/'\n```\n\nView [mkdocs site](https://www.mkdocs.org/#mkdocs) for more configuration options, customization and adding pages.\n\n### Updating App Icons\n\nYou can override the apps default icons by placing images into the following files:\n\n* ./docs/img/favicon.ico\n* ./docs/assets/icons/logo-36.png\n* ./docs/assets/icons/logo-192.png\n* ./docs/assets/icons/logo-512.png\n\n### Configuring The Web Manifiest\n\nConfigure additonal logos, set the name of the pwa, theme colors orientation etc by editing the manifest.json file located in ./docs/manifest.json refer to [Google Developer Docs](https://developers.google.com/web/fundamentals/web-app-manifest) for configuration options.\n\n```json\n{\n    \"name\": \"Site Name\",\n    \"short_name\": \"Site name\",\n    \"start_url\": \"index.html\",\n    \"display\": \"fullscreen\",\n    \"scope\": \".\",\n    \"orientation\":\"portrait\",\n    \"icons\": [\n    //...\n}\n```\n## Live Reload Server\nUse mkdocs live reload server to view changes during development. The service worker is not used inorder to see site changes.\n\n```\n$ mkdocs serve\n```\n\n## Updating The Site\nSimply edit the markdown files run the build command and redeploy. You may also want to update the version number of your app in mkdocs.yml.\n\n\u003cimg src=\"update.gif\" style=\"display block; margin-left:auto; margin-right:auto; width:180px; height:300px\"\u003e\n\nUsers who have the app installed would be prompted to update the next time they open it in online mode.\n\n\n## Build site\nOnce mkdocs and workbox is installed simply build the site with the following command.\n\n```bash\n$ npm run build\n```\nThe complete PWA should be built and located in ./site/\n\n\n## External Resouces for Customization\n\n1. [Mkdocs Configuration](https://www.mkdocs.org/user-guide/configuration/)\n2. [Mkdoc Materil Customization](https://squidfunk.github.io/mkdocs-material/customization/)\n3. [Mkdocs Material Extensions](https://squidfunk.github.io/mkdocs-material/extensions/admonition/)\n4. [Workbox Manifest Guide](https://developers.google.com/web/tools/workbox/guides/get-started)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnickdx%2Fpwadocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSnickdx%2Fpwadocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnickdx%2Fpwadocs/lists"}