{"id":13405517,"url":"https://github.com/peaceiris/mkdocs-material-boilerplate","last_synced_at":"2025-04-04T19:12:06.244Z","repository":{"id":36205590,"uuid":"167661225","full_name":"peaceiris/mkdocs-material-boilerplate","owner":"peaceiris","description":"MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with Docker, pipenv, and GitHub Actions.","archived":false,"fork":false,"pushed_at":"2025-03-03T01:58:55.000Z","size":8708,"stargazers_count":124,"open_issues_count":9,"forks_count":54,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T18:14:51.382Z","etag":null,"topics":["aws","boilerplate","docker","dockerfile","github-pages","gitlab-pages","mkdocs","mkdocs-material","netlify","starter-kit","static-site-generator"],"latest_commit_sha":null,"homepage":"https://mkdocs.peaceiris.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peaceiris.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"peaceiris","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-01-26T07:16:07.000Z","updated_at":"2025-03-03T01:58:34.000Z","dependencies_parsed_at":"2023-10-15T09:34:18.516Z","dependency_job_id":"e66d744e-67ff-4d42-931c-5e690638dc7c","html_url":"https://github.com/peaceiris/mkdocs-material-boilerplate","commit_stats":{"total_commits":605,"total_committers":5,"mean_commits":121.0,"dds":0.6049586776859504,"last_synced_commit":"02c117f0293a5d57f38a7a0c5bdef09a8edd4ca8"},"previous_names":[],"tags_count":125,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fmkdocs-material-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fmkdocs-material-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fmkdocs-material-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Fmkdocs-material-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peaceiris","download_url":"https://codeload.github.com/peaceiris/mkdocs-material-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234923,"owners_count":20905854,"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":["aws","boilerplate","docker","dockerfile","github-pages","gitlab-pages","mkdocs","mkdocs-material","netlify","starter-kit","static-site-generator"],"created_at":"2024-07-30T19:02:04.430Z","updated_at":"2025-04-04T19:12:06.227Z","avatar_url":"https://github.com/peaceiris.png","language":"Python","funding_links":["https://github.com/sponsors/peaceiris"],"categories":["Python","Links","boilerplate"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/peaceiris/mkdocs-material-boilerplate/main/docs_sample/images/graduate-cap.png\" alt=\"MkDocs icon\" width=\"170\"\u003e\n\u003cbr\u003eMkDocs Material\u003cbr\u003eBoilerplate - Starter Kit\n\u003c/h1\u003e\n\n![Eyecatch image of MkDocs Material Boilerplate (Starter Kit)](https://raw.githubusercontent.com/peaceiris/mkdocs-material-boilerplate/main/docs_sample/images/material.png)\n\n\n\n[![license](https://img.shields.io/github/license/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/blob/main/LICENSE)\n[![release](https://img.shields.io/github/release/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases/latest)\n[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/mkdocs-material-boilerplate.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/releases)\n[![GitHub Actions status](https://github.com/peaceiris/mkdocs-material-boilerplate/workflows/github%20pages/badge.svg)](https://github.com/peaceiris/mkdocs-material-boilerplate/actions)\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/9c95ccf4-5c1e-447b-8025-dd0b6f8764a5/deploy-status)](https://app.netlify.com/sites/mkdocs-material/deploys)\n\n\u003c!-- https://shields.io/ --\u003e\n\n\n\n## Details\n\nRead more 👉 [Documentation - MkDocs Material Boilerplate]\n\n[Documentation - MkDocs Material Boilerplate]: https://peaceiris.github.io/mkdocs-material-boilerplate/\n\n\n\n## Quick start\n\n```sh\ngit clone https://github.com/peaceiris/mkdocs-material-boilerplate.git\ncd mkdocs-material-boilerplate\npipenv sync --dev\npipenv shell\ninv serve --config-file mkdocs-sample.yml\n```\n\n\n\n## Links\n\n- [mkdocs/mkdocs: Project documentation with Markdown - GitHub]\n- [squidfunk/mkdocs-material: A Material Design theme for MkDocs]\n\n[mkdocs/mkdocs: Project documentation with Markdown - GitHub]: https://github.com/mkdocs/mkdocs/\n[squidfunk/mkdocs-material: A Material Design theme for MkDocs]: https://github.com/squidfunk/mkdocs-material\n\n\n\n## License\n\n- [MIT License]\n- [The graduate cap icon] made by [Freepik] from [www.flaticon.com] is licensed by [CC 3.0 BY]\n\n[MIT License]: https://github.com/peaceiris/mkdocs-material-boilerplate/blob/main/LICENSE\n[The graduate cap icon]: https://www.flaticon.com/free-icon/graduate-cap_62627\n[Freepik]: https://www.freepik.com/\n[www.flaticon.com]: https://www.flaticon.com/\n[CC 3.0 BY]: http://creativecommons.org/licenses/by/3.0/\n\n\n\n## About Maintainer\n\n- [peaceiris Homepage](https://peaceiris.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Fmkdocs-material-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeaceiris%2Fmkdocs-material-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Fmkdocs-material-boilerplate/lists"}