{"id":18671633,"url":"https://github.com/hardcode3/mkdocs_template","last_synced_at":"2026-01-28T21:34:24.686Z","repository":{"id":261514307,"uuid":"884505838","full_name":"Hardcode3/mkdocs_template","owner":"Hardcode3","description":"A template repository to generate html documentation using mkdocs and python.","archived":false,"fork":false,"pushed_at":"2024-11-07T17:45:18.000Z","size":758,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T06:30:08.921Z","etag":null,"topics":["documentation","mkdocs","python"],"latest_commit_sha":null,"homepage":"https://hardcode3.github.io/mkdocs_template/","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/Hardcode3.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-11-06T21:53:33.000Z","updated_at":"2024-11-07T17:45:00.000Z","dependencies_parsed_at":"2024-12-27T19:23:34.629Z","dependency_job_id":"1521f878-e083-4d4f-8209-ddc3db869a15","html_url":"https://github.com/Hardcode3/mkdocs_template","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"8890584eaf94f413c477c4ca9c6c028d2f376f6d"},"previous_names":["hardcode3/mkdocs_template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hardcode3%2Fmkdocs_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hardcode3%2Fmkdocs_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hardcode3%2Fmkdocs_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hardcode3%2Fmkdocs_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hardcode3","download_url":"https://codeload.github.com/Hardcode3/mkdocs_template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253877364,"owners_count":21977634,"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","python"],"created_at":"2024-11-07T09:06:28.843Z","updated_at":"2026-01-28T21:34:24.626Z","avatar_url":"https://github.com/Hardcode3.png","language":"Shell","readme":"# Python Project Template with MkDocs\n\nThis project is a template for creating Python projects with documentation generated using [MkDocs](https://www.mkdocs.org/). It provides a standard project structure, a sample `requirements.txt` for dependencies, and configurations for generating documentation in a simple, beautiful, and accessible format.\n\n![template_main_page_snapshot](/docs/res/template_main_page_snapshot.png).\n\n## Features\n\n- **Organized Python Project Structure**: Includes `docs/` directory for markdown documentation files.\n- **MkDocs Integration**: Easily create and serve project documentation locally or deploy to GitHub Pages.\n- **Dependency Management**: Use `requirements.txt` for managing project dependencies.\n- **Sample Scripts**: Helpful Bash scripts for managing virtual environments and installing dependencies.\n\n## Getting Started\n\n### Prerequisites\n\nMake sure you have the following installed:\n\n- **Python 3.6+**\n\n### Project Structure\n\n```plaintext\n.\n|── .github\n|   |── workflows        # Github actions scripts\n|   |── ...\n|── docs/                # MkDocs documentation files\n|   |── res              # Ressources (images, etc...) for the documentation\n|   |── stylesheets      # Custom CSS theme for your documentation\n|   |── index.md         # Home page for the documentation\n|   |── ...              # Additional documentation files\n|── scripts              # Scripts to generate the venv and deploy locally\n|── requirements.txt     # Python dependencies\n|── mkdocs.yml           # MkDocs configuration file\n.\n```\n\n### Installation\n\n1. **Clone the repository**:\n\n   ```bash\n   git clone https://github.com/username/repo-name.git\n   cd repo-name\n   ```\n\n2. **Create a virtual environment, installs dependencies** (recommended):\n\n   ```bash\n   sh scripts/venv.sh make\n   ```\n\n### Usage\n\n#### Running the Project\n\nYou can place your documentation files in the `docs/` directory and use it as your primary documentation location.\nEach new markdown file has to be registered in the [mdkocs.yml](mdkocs.yml) file (see [mkdocs documentation](https://www.mkdocs.org/)).\n\n#### Building and Serving Documentation\n\n1. **Build the documentation**:\n\n   ```bash\n   mkdocs build\n   ```\n\n   or\n\n   ```bash\n   sh scripts/build_static.sh\n   ```\n\n   This will generate static HTML files in the `site/` directory.\n\n2. **Serve documentation locally**:\n\n   ```bash\n   mkdocs serve\n   ```\n\n   or\n\n   ```bash\n   sh scripts/deploy_locally.sh\n   ```\n\n   Navigate to `http://127.0.0.1:8000` in your browser to view the documentation.\n\n#### Deploying Documentation to GitHub Pages\n\n- Push to the main branch and let the magic happen :blush:.\n\n## Configuration\n\nCustomize the MkDocs configuration by editing `mkdocs.yml`. Here you can change the site name, theme, navigation, and more.\n\n## Contributing\n\nIf you want to contribute to this project template:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/YourFeature`).\n3. Make your changes.\n4. Push your branch (`git push origin feature/YourFeature`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardcode3%2Fmkdocs_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhardcode3%2Fmkdocs_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardcode3%2Fmkdocs_template/lists"}