{"id":19366364,"url":"https://github.com/afritzler/mkdocs-gh-pages-action","last_synced_at":"2025-04-23T14:31:36.407Z","repository":{"id":37102960,"uuid":"346397996","full_name":"afritzler/mkdocs-gh-pages-action","owner":"afritzler","description":"Github Action to build and release mkdocs as Github Pages","archived":false,"fork":false,"pushed_at":"2025-04-22T08:27:17.000Z","size":229,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-22T09:35:48.475Z","etag":null,"topics":["docs","gh-pages","github-actions","github-enterprise","github-page","mkdocs","mkdocs-material","release-mkdocs"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/mkdocs-github-pages-releaser","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/afritzler.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-03-10T15:15:57.000Z","updated_at":"2025-04-22T08:26:52.000Z","dependencies_parsed_at":"2023-01-05T13:21:56.445Z","dependency_job_id":"9826494f-47da-4f18-b61c-d1817648e975","html_url":"https://github.com/afritzler/mkdocs-gh-pages-action","commit_stats":{"total_commits":139,"total_committers":5,"mean_commits":27.8,"dds":0.2086330935251799,"last_synced_commit":"e106a95bd9f7b128edbffc92180604051adad6d4"},"previous_names":[],"tags_count":191,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/afritzler%2Fmkdocs-gh-pages-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/afritzler%2Fmkdocs-gh-pages-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/afritzler%2Fmkdocs-gh-pages-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/afritzler%2Fmkdocs-gh-pages-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/afritzler","download_url":"https://codeload.github.com/afritzler/mkdocs-gh-pages-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250451776,"owners_count":21432895,"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":["docs","gh-pages","github-actions","github-enterprise","github-page","mkdocs","mkdocs-material","release-mkdocs"],"created_at":"2024-11-10T07:44:04.021Z","updated_at":"2025-04-23T14:31:36.031Z","avatar_url":"https://github.com/afritzler.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-gh-pages-action\n\n![license](https://img.shields.io/github/license/afritzler/mkdocs-gh-pages-action)\n\nGithub Action to build and release mkdocs as Github pages without using Docker.\nAt the core this action is using the [Mkdocs Material](https://squidfunk.github.io/mkdocs-material/) project\nto build your documentation.\n\n## Why?\n\nThere are already a couple of great Github actions out there building your mkdocs project\nand publishing it as Github pages such as\n\n* \u003chttps://github.com/marketplace/actions/deploy-mkdocs\u003e\n\nThis project aims to provide a Github action without using a Docker container in the build\nand publishing step. It comes handy for people running in a Github Enterprise environment using\n`self-hosted` runners which don't have Docker-in-Docker support enabled.\n\n## Usage\n\nHere is an example on how to use this action to publish your project:\n\n```yaml\nname: Publish docs via GitHub Pages\n\non:\n  push:\n    branches: [ main ]\n\njobs:\n  build:\n    name: Deploy docs\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout main\n        uses: actions/checkout@v2\n\n      - uses: actions/setup-python@v2\n        with:\n          python-version: 'pypy-3.6'\n\n      - name: Deploy docs\n        uses: afritzler/mkdocs-gh-pages-action@main\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          #GITHUB_DOMAIN: github.myenterprise.com\n```\n\n## Configuration\n\nThis action can be configured by setting the following `env` varibles\n\n| **ENV VAR**        | **Default Value**     | **Notes**                                                                                         |\n| ------------------ | --------------------- | ------------------------------------------------------------------------------------------------- |\n| **CUSTOM_DOMAIN**  | `none`                | Custom domain name which is being written into the CNAME file of your gh-pages branch.            |\n| **CONFIG_FILE**    | `mkdocs.yml`          | Custom Mkdocs configuration file relative in your project folder structure.                       |\n| **GITHUB_TOKEN**   | `none`                | Personal Github token which should be used during execution.                                      |\n| **PERSONAL_TOKEN** | `none`                | Personal access token which should be used during execution.                                      |\n| **GITHUB_DOMAIN**  | `github.com`          | Specify a custom Github domain in case Github Enterprise is used: e.g. `github.myenterprise.com`. |\n| **ACTOR**          | `author of PR/commit` | Overwrite the author of the PR/commit.                                                            |\n| **REQUIREMENTS**   | `requirements.txt`    | Specify a custom `requirements.txt` file to use custom Python modules.                            |\n| **FORCE**          | `\"true\"`              | Force defines if the `mkdocs` build artefacts should be force pushed into the `gh-pages` |\n\n## Using custom modules\n\nBy default this action is looking for the presents of a `requirements.txt` in your project to install your custom modules.\n\nExample: Lets say you want to install the following modules as they represent Mkdocs plugins used by your project:\n\n```shell\nmkdocs-same-dir==v0.1.0\nmdx_truly_sane_lists==1.2\n```\n\nCreate a corresponding file containing a versioned list of those modules (`pip freeze`). You can override the default filename `requirements.txt` by\nsetting the `REQUIREMENTS` environment variable.\n\n```yaml\n- name: Deploy docs\n  uses: afritzler/mkdocs-gh-pages-action@main\n  env:\n    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n    REQUIREMENTS: myawesome-requirements.txt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fafritzler%2Fmkdocs-gh-pages-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fafritzler%2Fmkdocs-gh-pages-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fafritzler%2Fmkdocs-gh-pages-action/lists"}