{"id":13474417,"url":"https://github.com/peaceiris/actions-mkdocs-gh-pages","last_synced_at":"2025-03-26T21:31:30.406Z","repository":{"id":101439194,"uuid":"183504729","full_name":"peaceiris/actions-mkdocs-gh-pages","owner":"peaceiris","description":"GitHub Actions for MkDocs and GitHub Pages - Build markdown documentation with Material for MkDocs and deploy to GitHub Pages automatically","archived":true,"fork":false,"pushed_at":"2019-10-15T22:44:49.000Z","size":234,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-30T07:47:46.402Z","etag":null,"topics":["github-actions","github-pages","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"","language":"Shell","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-04-25T20:24:14.000Z","updated_at":"2024-07-23T20:40:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"597b7d62-21ca-418c-8d4e-618e1b8646cd","html_url":"https://github.com/peaceiris/actions-mkdocs-gh-pages","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Factions-mkdocs-gh-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Factions-mkdocs-gh-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Factions-mkdocs-gh-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peaceiris%2Factions-mkdocs-gh-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peaceiris","download_url":"https://codeload.github.com/peaceiris/actions-mkdocs-gh-pages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245738634,"owners_count":20664320,"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-actions","github-pages","mkdocs","mkdocs-material"],"created_at":"2024-07-31T16:01:12.197Z","updated_at":"2025-03-26T21:31:30.388Z","avatar_url":"https://github.com/peaceiris.png","language":"Shell","funding_links":["https://github.com/sponsors/peaceiris"],"categories":["Community Resources"],"sub_categories":["GitHub Pages"],"readme":"This repository will not be updated in the future.\n\nPlease, use the following GitHub Actions.\n\n- [peaceiris/actions-gh-pages: GitHub Actions for deploying to GitHub Pages with Static Site Generators](https://github.com/peaceiris/actions-gh-pages)\n\n\n\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand the old README\u003c/summary\u003e\n\n\n\n[![license](https://img.shields.io/github/license/peaceiris/actions-mkdocs-gh-pages.svg)](https://github.com/peaceiris/actions-mkdocs-gh-pages/blob/master/LICENSE)\n[![release](https://img.shields.io/github/release/peaceiris/actions-mkdocs-gh-pages.svg)](https://github.com/peaceiris/actions-mkdocs-gh-pages/releases/latest)\n[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-mkdocs-gh-pages.svg)](https://github.com/peaceiris/actions-mkdocs-gh-pages/releases)\n\n\n\n## GitHub Actions for MkDocs and GitHub Pages\n\nBuild markdown documentation with [Material for MkDocs] and deploy to GitHub Pages automatically.\n\n[Material for MkDocs]: https://github.com/squidfunk/mkdocs-material\n\n![material.png](https://raw.githubusercontent.com/peaceiris/actions-mkdocs-gh-pages/master/material.png)\n\n\n\n## Sample repository\n\n[peaceiris/mkdocs-material-boilerplate: MkDocs Material Boilerplate (Starter Kit)]\n\n\u003e  Deploy documentation to hosting platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with CircleCI, Docker, pipenv, GitHub Actions\n\n[peaceiris/mkdocs-material-boilerplate: MkDocs Material Boilerplate (Starter Kit)]: https://github.com/peaceiris/mkdocs-material-boilerplate\n\n\n\n## Getting started\n\n### (1) Add deploy Key\n\n1. Generate deploy key `ssh-keygen -t rsa -b 4096 -C \"your@email.com\" -f mkdocs -N \"\"`\n2. Go to \"Settings \u003e Deploy Keys\" of repository.\n3. Add your public key within \"Allow write access\" option.\n4. Go to \"Settings \u003e Secrets\" of repository.\n5. Add your private deploy key as `ACTIONS_DEPLOY_KEY`\n\n### (2) Workflow\n\n```hcl\nworkflow \"MkDocs workflow\" {\n  on = \"push\"\n  resolves = [\"Build and deploy\"]\n}\n\naction \"branch-filter\" {\n  uses = \"actions/bin/filter@master\"\n  args = \"branch master\"\n}\n\naction \"Build and deploy\" {\n  needs = \"branch-filter\"\n  uses = \"peaceiris/actions-mkdocs-gh-pages@v1.2.0\"\n  env = {\n    MKDOCS_BUILD_OPTIONS = \"--config-file ./mkdocs-sample.yml\"\n  }\n  secrets = [\"ACTIONS_DEPLOY_KEY\"]\n}\n\n```\n\n### (3) Push to master branch\n\nWhen you push to master branch, GitHub Actions runs.\n\n\n\n## License\n\n[MIT License - peaceiris/actions-mkdocs-gh-pages]\n\n[MIT License - peaceiris/actions-mkdocs-gh-pages]: https://github.com/peaceiris/actions-mkdocs-gh-pages/blob/master/LICENSE\n\n\n\n## About the author\n\n- [peaceiris's homepage](https://peaceiris.com/)\n\n\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Factions-mkdocs-gh-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeaceiris%2Factions-mkdocs-gh-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeaceiris%2Factions-mkdocs-gh-pages/lists"}