{"id":22557979,"url":"https://github.com/jd-apprentice/mkdocs-template","last_synced_at":"2026-02-12T08:32:15.110Z","repository":{"id":266769287,"uuid":"899286352","full_name":"jd-apprentice/mkdocs-template","owner":"jd-apprentice","description":"Template to startup a documentation site with mkdocs","archived":false,"fork":false,"pushed_at":"2024-12-06T02:39:01.000Z","size":1315,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-28T18:48:20.951Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/jd-apprentice.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}},"created_at":"2024-12-06T00:50:59.000Z","updated_at":"2025-04-15T20:54:42.000Z","dependencies_parsed_at":"2024-12-06T03:23:27.919Z","dependency_job_id":"4a75d338-6bb8-4deb-b01a-95494dbfdd80","html_url":"https://github.com/jd-apprentice/mkdocs-template","commit_stats":null,"previous_names":["jd-apprentice/mkdocs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/jd-apprentice/mkdocs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fmkdocs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fmkdocs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fmkdocs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fmkdocs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jd-apprentice","download_url":"https://codeload.github.com/jd-apprentice/mkdocs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fmkdocs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29361818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T01:03:07.613Z","status":"online","status_checked_at":"2026-02-12T02:00:06.911Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-07T20:10:21.472Z","updated_at":"2026-02-12T08:32:15.092Z","avatar_url":"https://github.com/jd-apprentice.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# MKDocs Starter\n\nTemplate to startup a documentation site with mkdocs\n\n![sample](assets/sample.png)\n\n## Contains\n\n- base setup\n- [github-actions](https://github.com/peaceiris/actions-gh-pages/tree/v4/)\n- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)\n\n## Configuration\n\nChange the `site_name` in `mkdocs.yml`\n\n### Not using a custom domain\n\nIf you don't have a domain, remove the property the `cname` in `.github/workflows/ci.yml`\n\n### Using a custom domain\n\nChange the `cname` in `.github/workflows/ci.yml`\n\nIn case you are using a custom domain you must create the CNAME in your DNS resolver\n\n![domain](assets/domain.png)\n\nYou point the CNAME (the one we are using at .github/workflows/ci.yml) to your github.io page which is normally `\u003cusername\u003e.github.io`\n\n### Enable GitHub Pages\n\nAfter the first push, a branch with the name of `gh-pages` will be created, now we do the following\n\n![gh-pages](assets/gh-pages.png)\n\n### Theme\n\nIf you don't want to use material theme, change the `theme` in `mkdocs.yml` and `.github/workflows/ci.yml`\nYou can read more about it [HERE](https://www.mkdocs.org/user-guide/choosing-your-theme/)\n\n## Workflow\n\n![idea](assets/idea.png)\n\n```shell\n🌳 mkdocs-template/\n┣ 📁 .github/\n┃ ┗ 📁 workflows/\n┃   ┗ 📄 ci.yml\n┣ 📁 docs/ -- Create your docs here\n┃ ┗ 📄 index.md\n┣ 📄 LICENSE\n┣ 📄 README.md\n┗ 📄 mkdocs.yml\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjd-apprentice%2Fmkdocs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjd-apprentice%2Fmkdocs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjd-apprentice%2Fmkdocs-template/lists"}