{"id":15023093,"url":"https://github.com/g3xx/mkdocs-github","last_synced_at":"2025-10-30T08:43:52.629Z","repository":{"id":57442136,"uuid":"242906173","full_name":"g3xx/mkdocs-Github","owner":"g3xx","description":"Theme Mkdocs Like a Github. DEMO =\u003e","archived":false,"fork":false,"pushed_at":"2020-02-25T09:13:04.000Z","size":61,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T13:16:40.066Z","etag":null,"topics":["github-theme","mkdocs","mkdocs-theme","theme"],"latest_commit_sha":null,"homepage":"https://github.g3xx.com/","language":"CSS","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/g3xx.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}},"created_at":"2020-02-25T04:04:58.000Z","updated_at":"2025-02-18T20:27:56.000Z","dependencies_parsed_at":"2022-09-26T17:21:01.926Z","dependency_job_id":null,"html_url":"https://github.com/g3xx/mkdocs-Github","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g3xx%2Fmkdocs-Github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g3xx%2Fmkdocs-Github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g3xx%2Fmkdocs-Github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/g3xx%2Fmkdocs-Github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/g3xx","download_url":"https://codeload.github.com/g3xx/mkdocs-Github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824589,"owners_count":21167343,"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":["github-theme","mkdocs","mkdocs-theme","theme"],"created_at":"2024-09-24T19:58:43.816Z","updated_at":"2025-10-30T08:43:47.598Z","avatar_url":"https://github.com/g3xx.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mkdocs-Github Theme for MkDocs\n\n## About\n\nSimple Theme for Mkdocs.\n\n## Install\n\n**\u003cem\u003eRequired\u003c/em\u003e**: Python 3.4+\n\nIf you haven't installed MkDocs yet, use the following command to install it:\n\n\u003cpre\u003e\u003ccode class=\"shell\"\u003e$ pip install mkdocs\u003c/code\u003e\u003c/pre\u003e\nNext, navigate to a clean directory and create a new MkDocs project with the following command:\n\n\u003cpre\u003e\u003ccode class=\"shell\"\u003e$ mkdocs new [projectname]\u003c/code\u003e\u003c/pre\u003e\nReplace `[projectname]` with the name of your project (without the brackets).\n\nThen navigate to the root of your project directory:\n\n\u003cpre\u003e\u003ccode class=\"shell\"\u003e$ cd [projectname]\u003c/code\u003e\u003c/pre\u003e\n## Install  Github Theme\n\nwith PIP `pip install mkdocs-github` or download with zip.\n\n## Configuration\n\n**mkdocs.yml** for install via **zip**\n\n```yml\nsite_name: yourdocs\nsite_author: you\nsite_description: \"you word.\"\nsite_keyword: \"you word\"\n\ntheme:\n  name: null\n  custom_dir: github\n  highlightjs: true\n  hljs_style: github\n \nbadge:\n github_repo: mkdocs-Github \n github_user: g3xx\n```\n\n**mkdocs.yml** with install via **PIP**\n\n```yml\nsite_name: yourdocs\nsite_author: you\nsite_description: \"you word\"\nsite_keyword: \"your tag\"\n\ntheme:\n  name: github\n  highlightjs: true\n  hljs_style: github\n \nbadge:\n github_repo: antiFramework \n github_user: g3xx\n\n```\n\n## License\n\n**MIT** and CSS by [sindresorhus](https://github.com/sindresorhus/github-markdown-css)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg3xx%2Fmkdocs-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg3xx%2Fmkdocs-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg3xx%2Fmkdocs-github/lists"}