├── docs ├── js │ └── extra.js ├── css │ └── extra.css └── index.md ├── .gitignore ├── requirements.txt ├── mkdocs.yml ├── .github └── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md └── README.md /docs/js/extra.js: -------------------------------------------------------------------------------- 1 | // PLACEHOLDER 2 | -------------------------------------------------------------------------------- /docs/css/extra.css: -------------------------------------------------------------------------------- 1 | /* PLACEHOLDER */ 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | site/ 2 | .DS_Store 3 | local_git_config.sh 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs==1.0.4 2 | mkdocs-material==4.4.3 3 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Home 2 | 3 | Welcome to [mkdocs-template](https://github.com/zwbetz-gh/mkdocs-template). The no-excuses template to document your project. 4 | -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: MkDocs Template 2 | site_description: The no-excuses template to document your project 3 | site_url: https://zwbetz-gh.github.io/mkdocs-template/ 4 | repo_url: https://github.com/zwbetz-gh/mkdocs-template 5 | edit_uri: edit/main/docs/ 6 | theme: 7 | name: material 8 | feature: 9 | tabs: false 10 | palette: 11 | primary: indigo 12 | accent: indigo 13 | extra_css: 14 | - css/extra.css 15 | extra_javascript: 16 | - js/extra.js 17 | markdown_extensions: 18 | - admonition 19 | - codehilite: 20 | guess_lang: false 21 | - toc: 22 | permalink: '#' 23 | nav: 24 | - index.md 25 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MkDocs Template 2 | 3 | The no-excuses template to document your project. Powered by [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [GitHub Pages](https://pages.github.com/). 4 | 5 | ## View Published Docs 6 | 7 | 8 | 9 | ## One-Time Setup 10 | 11 | 1. Fork or [download a zip](https://github.com/zwbetz-gh/mkdocs-template/archive/main.zip) of this repo 12 | 1. Install `python3` (which should include `pip3`) 13 | 1. Install requirements 14 | 15 | pip3 install -r requirements.txt 16 | 17 | 1. Fill out the `mkdocs.yml` file with your info 18 | 19 | ## Make Your Docs 20 | 21 | 1. Make your documentation changes 22 | 1. Preview your changes at [`http://127.0.0.1:8000`](http://127.0.0.1:8000) 23 | 24 | mkdocs serve 25 | 26 | 1. Deploy your changes to GitHub Pages 27 | 28 | mkdocs gh-deploy 29 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | --------------------------------------------------------------------------------