{"id":22537473,"url":"https://github.com/josepizarro3/material-mkdocs-template","last_synced_at":"2026-07-19T23:36:27.501Z","repository":{"id":266814124,"uuid":"899417317","full_name":"JosePizarro3/material-mkdocs-template","owner":"JosePizarro3","description":"A template to build documentation pages using MkDocs","archived":false,"fork":false,"pushed_at":"2024-12-06T10:15:35.000Z","size":767,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T06:41:41.871Z","etag":null,"topics":["documentation","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://josepizarro3.github.io/material-mkdocs-template/","language":null,"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/JosePizarro3.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}},"created_at":"2024-12-06T08:17:36.000Z","updated_at":"2024-12-06T10:15:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"e50a2484-1d3f-4867-9297-5e97e05bcd8e","html_url":"https://github.com/JosePizarro3/material-mkdocs-template","commit_stats":null,"previous_names":["josepizarro3/mkdocs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/JosePizarro3/material-mkdocs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JosePizarro3%2Fmaterial-mkdocs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JosePizarro3%2Fmaterial-mkdocs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JosePizarro3%2Fmaterial-mkdocs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JosePizarro3%2Fmaterial-mkdocs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JosePizarro3","download_url":"https://codeload.github.com/JosePizarro3/material-mkdocs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JosePizarro3%2Fmaterial-mkdocs-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263606782,"owners_count":23487695,"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":["documentation","mkdocs","mkdocs-material"],"created_at":"2024-12-07T11:07:01.296Z","updated_at":"2025-10-10T20:01:35.383Z","avatar_url":"https://github.com/JosePizarro3.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs template\n\nA template to build documentation pages using MkDocs, especifically using the Material for MkDocs theme and the PyMdown extensions.\n\n\n## Getting started\n\nClone this repository by clicking on the top right button, `Use this template`:\n\n\u003cimg src=\"docs/assets/images/use-this-template.png\" width=\"100%\" title=\"Click in Use this template button\"\u003e\n\nYou can decide which organization or account to host the new repository. Don't forget to check the `Include all branches` button.\n\n\u003cimg src=\"docs/assets/images/include-all-branches.png\" width=\"100%\" title=\"Check Include all brunches box\"\u003e\n\n## The configuration file\n\nThe configuration file should appear in the root of your project with the name `mkdocs.yml`. Here, you can control the structure and customization (with different themes, extensions, assets, etc.) of your page.\n\nI tried adding some of the most useful configurations and comments in the `mkdocs.yml`, but it is a good idea to visit the (amazing) documentation page of [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/).\n\n## Adding pages\n\nThe pages in MkDocs are written in [Markdown](https://www.markdownguide.org/) and are found in the folder `docs`. The structure is defined in the `mkdocs.yml` under the `nav` key.\n\n## Local development\n\nIn order to develop and write the documentation page, you only need an OS with Python 3.x. Then, you have to:\n\n* Create a virtual environment (either with venv or conda). In my case I used Ubuntu 22.04 to setup my environment:\n```sh\npython3 -m venv .venv\nsource .venv/bin/activate\n```\n* Make sure `pip` is upgraded:\n```sh\npip install --upgrade pip\n```\n* Install the dependencies:\n```sh\npip install -r requirements_docs.txt\n```\n* Run the MkDocs page:\n```sh\nmkdocs serve\n```\n\nYou will get an output which looks like this:\n```sh\nINFO    -  Building documentation...\nINFO    -  Cleaning site directory\nINFO    -  [14:07:47] Watching paths for changes: 'docs', 'mkdocs.yml'\nINFO    -  [14:07:47] Serving on http://127.0.0.1:8000/\n```\n\nSimply click on the local address (http://127.0.0.1:8000/) to see the page launched.\n\nEverytime you modify and save your files, the MkDocs page will automatically update with the latest changes.\n\n## Github page\n\nOnce the MkDocs page is ready, you can push the changes into your main branch. \n\nThe pipeline defined in `.github/workflows/mkdocs-deploy.yml` will deploy the MkDocs page on the Github page of your repository. This is in the branch called `gh-page` (this is the reason why the button `Include all branches` should be checked). Everytime someone pushes changes into the `main` branch, the pipeline will update the MkDocs page.\n\nThe Github/MkDocs page have the format: https://\u003cORGANIZATION/USER-NAME\u003e.github.io/\u003cREPOSITORY-NAME\u003e/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosepizarro3%2Fmaterial-mkdocs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosepizarro3%2Fmaterial-mkdocs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosepizarro3%2Fmaterial-mkdocs-template/lists"}