https://github.com/fu-sen/githubpages-mkdocs

📃 MkDocs with :octocat: GitHub Pages via GitHub Actions (minimal configuration)
https://github.com/fu-sen/githubpages-mkdocs

github-action github-actions github-page github-pages github-pages-website mkdocs mkdocs-site mkdocs-sites

Last synced: about 1 month ago
JSON representation

📃 MkDocs with :octocat: GitHub Pages via GitHub Actions (minimal configuration)

• Host: GitHub
• URL: https://github.com/fu-sen/githubpages-mkdocs
• Owner: fu-sen
• Created: 2022-08-26T10:48:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-21T06:51:14.000Z (9 months ago)
• Last Synced: 2024-04-21T07:33:40.793Z (9 months ago)
• Topics: github-action, github-actions, github-page, github-pages, github-pages-website, mkdocs, mkdocs-site, mkdocs-sites
• Homepage: https://mkdocs.balloon.net.eu.org
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## GitHubPages-MkDocs

**MkDocs with GitHub Pages via GitHub Actions (minimal configuration)**

- [GitHub Pages](https://pages.github.com/)

- [MkDocs](https://www.mkdocs.org/)

MkDocs 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.

## How to use

1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.

2. Add the pip package to `requirements.txt` . (Themes and plugins)

3. Commit to a Git project: `git push`

4. Select **Setting - Pages** from the GitHub project, Select **GitHub Actions** for "Source".

5. Set "Custom domain" if necessary. (Note: `CNAME` file does not work with GitHub Actions)

## Build error

Many of the build error are that you mistyped `mkdocs.yml`

or you forgot to add the package to` requirements.txt`.

Check the file change immediately before the error occurred.

This is often not a problem with this project.

You should not open an issue for that.

## Fork of this project

If you fork this project, be sure to change something and commit.

If you re-deploy without changing anything, it's my commit and I'll be notified.