{"id":47216954,"url":"https://github.com/encode/mkdocs","last_synced_at":"2026-03-13T16:06:13.546Z","repository":{"id":339702050,"uuid":"1076787641","full_name":"encode/mkdocs","owner":"encode","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-19T12:16:48.000Z","size":1121,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-10T10:31:40.512Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.encode.io/mkdocs/","language":"Python","has_issues":false,"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/encode.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":"2025-10-15T10:47:44.000Z","updated_at":"2026-03-06T22:37:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/encode/mkdocs","commit_stats":null,"previous_names":["encode/mkdocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/encode/mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encode%2Fmkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encode%2Fmkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encode%2Fmkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encode%2Fmkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/encode","download_url":"https://codeload.github.com/encode/mkdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encode%2Fmkdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30469945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-13T11:00:43.441Z","status":"ssl_error","status_checked_at":"2026-03-13T11:00:23.173Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2026-03-13T16:06:12.936Z","updated_at":"2026-03-13T16:06:13.534Z","avatar_url":"https://github.com/encode.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs\n\nMkDocs is a smart, simple, website design tool.\n\n![MkDocs](docs/img/mkdocs.png)\n\n\u003cbr/\u003e\n\n## Installation\n\nInstall the `mkdocs` command line tool...\n\n```shell\n$ pip install git+https://github.com/encode/mkdocs.git\n```\n\n*This will install the version 2.0 pre-release.*\n\n\u003cbr/\u003e\n\n## Getting started\n\n1. Create a `README.md` page.\n2. Run `mkdocs serve` to view your documentation in a browser.\n3. Run `mkdocs build` to build a static website ready to host.\n\n*MkDocs supports [GitHub Flavored Markdown](docs/writing.md) for page authoring.*\n\n\u003cbr/\u003e\n\n## Writing your docs\n\n1. Create additional markdown pages.\n2. Use [markdown interlinking](docs/navigation.md#interlinking) between pages.\n3. Create a `mkdocs.toml` file to define [the site navigation](docs/navigation.md#navigation) and other configuration.\n4. Move your markdown pages into a `docs` directory, and update the config.\n\nAn example `mkdocs.toml`...\n\n```toml\n[mkdocs]\nnav = [\n    {path=\"README.md\", title=\"Introduction\"},\n    {path=\"CREDITS.md\", title=\"Credits\"},\n]\n\n[loaders]\ntheme = \"pkg://mkdocs/default\"\ndocs = \"dir://docs\"\n\n[context]\ntitle = \"Documentation\"\nfavicon = \"📘\"\n```\n\n*Use either [`README.md` or `index.md`](docs/navigation.md#url-structure) for the homepage.*\n\n\u003cbr/\u003e\n\n## Custom styling\n\nStyling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.\n\n1. Configure the base theme for your project.\n2. Modify [the HTML templating](docs/styling.md#templates) to customise the layout.\n3. Override or add [CSS and JavaScript](docs/styling.md#statics) static assets.\n\nTake a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.\n\n\u003cbr/\u003e\n\n![Kelp](docs/img/kelp.png)\n\n*The MkDocs documentation, served with the Kelp theme.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fencode%2Fmkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fencode%2Fmkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fencode%2Fmkdocs/lists"}