{"id":21755113,"url":"https://github.com/fu-sen/githubpages-mkdocs","last_synced_at":"2026-04-16T14:32:57.387Z","repository":{"id":73183829,"uuid":"529219104","full_name":"fu-sen/GitHubPages-MkDocs","owner":"fu-sen","description":"📃 MkDocs with :octocat: GitHub Pages via GitHub Actions (minimal configuration)","archived":false,"fork":false,"pushed_at":"2024-11-03T11:34:35.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-25T23:49:01.211Z","etag":null,"topics":["github-action","github-actions","github-page","github-pages","github-pages-website","mkdocs","mkdocs-site","mkdocs-sites"],"latest_commit_sha":null,"homepage":"https://mkdocs.balloon.net.eu.org","language":null,"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/fu-sen.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,"dei":null}},"created_at":"2022-08-26T10:48:36.000Z","updated_at":"2024-11-03T11:34:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"f86707da-6915-47f9-aa26-061bc53f24a7","html_url":"https://github.com/fu-sen/GitHubPages-MkDocs","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/fu-sen%2FGitHubPages-MkDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FGitHubPages-MkDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FGitHubPages-MkDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FGitHubPages-MkDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fu-sen","download_url":"https://codeload.github.com/fu-sen/GitHubPages-MkDocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244728237,"owners_count":20500023,"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":["github-action","github-actions","github-page","github-pages","github-pages-website","mkdocs","mkdocs-site","mkdocs-sites"],"created_at":"2024-11-26T09:16:40.825Z","updated_at":"2026-04-16T14:32:57.350Z","avatar_url":"https://github.com/fu-sen.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- 2024/10/03 MkDocs 1.6.1 --\u003e\n\n## GitHubPages-MkDocs\n\n**MkDocs with GitHub Pages via GitHub Actions (minimal configuration)**\n\n- [GitHub Pages](https://pages.github.com/)\n- [MkDocs](https://www.mkdocs.org/)\n\nMkDocs has a `mkdocs gh-deploy` command, but using this method you can publish the original source to the repository instead of the built HTML. You commit instead of the MkDocs command.\n\n## How to use\n\n1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.\n2. Add the pip package to `requirements.txt` . (Themes and plugins)\n3. Commit to a Git project: `git push`\n4. Select **Setting - Pages** from the GitHub project, Select **GitHub Actions** for \"Source\".\n5. Set \"Custom domain\" if necessary. (Note: `CNAME` file does not work with GitHub Actions)\n\n## Build error\n\nMany of the build error are that you mistyped `mkdocs.yml`\nor you forgot to add the package to` requirements.txt`.\nCheck the file change immediately before the error occurred.\n\nThis is often not a problem with this project.\nYou should not open an issue for that.\n\n## Fork of this project\n\nIf you fork this project, be sure to change something and commit.\nIf you re-deploy without changing anything, it's my commit and I'll be notified.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffu-sen%2Fgithubpages-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffu-sen%2Fgithubpages-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffu-sen%2Fgithubpages-mkdocs/lists"}