{"id":48562863,"url":"https://github.com/iitrabhi/mkdocs-template","last_synced_at":"2026-04-08T12:35:54.629Z","repository":{"id":217371464,"uuid":"743681305","full_name":"iitrabhi/mkdocs-template","owner":"iitrabhi","description":"For any academic or research project, documenting the code is essential. ","archived":false,"fork":false,"pushed_at":"2026-02-10T17:11:18.000Z","size":3765,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-10T20:46:31.372Z","etag":null,"topics":["class-notes","documentation","github-pages","markdown","mkdocs","pages","readthedocs","website"],"latest_commit_sha":null,"homepage":"https://abhigupta.io/mkdocs-template/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iitrabhi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-15T18:55:37.000Z","updated_at":"2026-02-10T17:11:51.000Z","dependencies_parsed_at":"2024-01-16T02:18:13.664Z","dependency_job_id":"7ad7a716-99b1-426e-8b8b-676577a097d3","html_url":"https://github.com/iitrabhi/mkdocs-template","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.4375,"last_synced_commit":"b9e98f7bc1a6e34fcc7f0cd2a11dddc5a31c7650"},"previous_names":["iitrabhi/mkdocs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/iitrabhi/mkdocs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iitrabhi%2Fmkdocs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iitrabhi%2Fmkdocs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iitrabhi%2Fmkdocs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iitrabhi%2Fmkdocs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iitrabhi","download_url":"https://codeload.github.com/iitrabhi/mkdocs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iitrabhi%2Fmkdocs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31556238,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T10:21:54.569Z","status":"ssl_error","status_checked_at":"2026-04-08T10:21:38.171Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["class-notes","documentation","github-pages","markdown","mkdocs","pages","readthedocs","website"],"created_at":"2026-04-08T12:35:53.670Z","updated_at":"2026-04-08T12:35:54.620Z","avatar_url":"https://github.com/iitrabhi.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Website (MkDocs + GitHub Pages)\n\nFor any academic or research project, **documenting the code is essential**. Clear documentation enables reproducibility, supports collaboration, and ensures that scientific ideas remain understandable beyond the original development phase.\n\nThis repository provides a **simple, reproducible documentation workflow** that connects local note-taking with automatic website deployment.\n\nHow to use this template\n1.\tWrite your documentation\n\t- Place all documentation files inside the `docs/` directory.\n\t- Ensure `docs/mkdocs.yml` exists and is correctly configured.\n2.\tUse the provided workflow\n\t- The workflow file (in `.github/workflows/`) builds the site using MkDocs and deploys it to GitHub Pages on every push to main.\n3.\tEnable GitHub Pages\n\t- Go to `Settings` → `Pages` in your GitHub repository.\n\t- Under Source, select: `Deploy from a GitHub Actions workflow`\n\t- Save the settings.\n4.\tDeploy\n\t- Push changes to the main branch.\n\t- GitHub Actions will automatically build and publish your documentation website.\n\n## Result\n\nYour documentation will be available at: `https://\u003cusername\u003e.github.io/\u003crepository-name\u003e/`\n\nNo manual deployment steps are required after setup.\n\n\n## Writing Documentation\n\nAll documentation is written in the `docs/` folder.\n\n- The repository is preconfigured for **Obsidian**.\n- Open the repository directly in Obsidian to start writing.\n- Write documentation as plain Markdown files.\n- Use Obsidian for structured notes, links, and incremental writing.\n\n## Publishing Documentation\n\nThe documentation website is built using **MkDocs** and deployed automatically to **GitHub Pages**.\n\nWhen you:\n- add a new chapter\n- add a new lesson or page\n- reorganize content\n\nyou must update `mkdocs.yml` to include the new files in the navigation. This step is required for the content to appear on the rendered website.\n\n## Workflow Summary\n\n- Write notes in `docs/` using Obsidian\n- Commit changes to the repository\n- Update `mkdocs.yml` when adding new pages\n- Push to `main`\n- GitHub Actions builds and publishes the documentation website automatically\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiitrabhi%2Fmkdocs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiitrabhi%2Fmkdocs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiitrabhi%2Fmkdocs-template/lists"}