{"id":15017427,"url":"https://github.com/mkdocs/sketch","last_synced_at":"2025-10-28T11:41:57.310Z","repository":{"id":240260442,"uuid":"802129026","full_name":"mkdocs/sketch","owner":"mkdocs","description":"...","archived":false,"fork":false,"pushed_at":"2024-08-04T15:43:30.000Z","size":127,"stargazers_count":10,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-04T07:37:12.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/mkdocs.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}},"created_at":"2024-05-17T15:16:36.000Z","updated_at":"2024-10-09T13:58:56.000Z","dependencies_parsed_at":"2024-05-17T16:43:29.240Z","dependency_job_id":"7148aee6-8aa8-41a3-b98f-a4c9cfb1319d","html_url":"https://github.com/mkdocs/sketch","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"ab4d393f2fde4582016a2cc175cb09519b08437e"},"previous_names":["mkdocs/sketch"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fsketch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fsketch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fsketch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fsketch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocs","download_url":"https://codeload.github.com/mkdocs/sketch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237152828,"owners_count":19263792,"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":[],"created_at":"2024-09-24T19:50:27.037Z","updated_at":"2025-10-19T14:32:19.040Z","avatar_url":"https://github.com/mkdocs.png","language":"JavaScript","readme":"# Insiders\n\n$redesign$ $sketch$ $work$\n\n---\n\n## What\n\nThere's a much cleaner `mkdocs` under the hood, waiting to be let out.\n\n*This is a space for design exploration.*\n\nAt the same time we also need to continue to improve mkdocs as it currently stands.\nI'm planning on taking a dual approach here...\n\n* Incremental improvements to the existing `mkdocs`. *(As a minimum the default theme needs freshening up.)*\n* Explore this design space, and determine how we can best move forward in places where more fundamental changes are required.\n\n## Core design themes\n\n*TODO: Expand on this.*\n\n#### １ A clean obvious build context for themes to work with.\n\nhttps://github.com/mkdocs/insiders/blob/main/mkdocs/site.py\n\n#### ２ Templating over code.\n\nSafe rendering, avoid Python knowledge as a dependancy.\n\n#### ３ Kiss.\n\nOnboarding etc.\n\n## Give it a whirl\n\n```\ngit clone https://github.com/encode/httpx\ncd httpx\npython -m venv venv\nvenv/bin/pip install git+https://github.com/mkdocs/sketch\nvenv/bin/mkdocs serve\n```\n\n\u003cimg width=\"1230\" alt=\"image\" src=\"https://github.com/mkdocs/sketch/assets/647359/d94d3325-750c-4c13-a4fb-60c1422173d7\"\u003e\n\n## What's the big deal\n\n* `mkdocs serve` renders pages on the fly. There's no \"build the whole site\" process needed.\n* The context passed to the theme [is completely cleaned up](https://github.com/mkdocs/sketch/blob/main/mkdocs/site.py). I'll write about this as we go, there's a really clean clear data model that's passed through to the templating.\n* More to come...\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fsketch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocs%2Fsketch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fsketch/lists"}