{"id":18606063,"url":"https://github.com/hfagerlund/mkdocs-docskimmer","last_synced_at":"2025-04-10T20:31:27.593Z","repository":{"id":164264932,"uuid":"94152739","full_name":"hfagerlund/mkdocs-docskimmer","owner":"hfagerlund","description":"An accessible, skimmable theme for MkDocs","archived":false,"fork":false,"pushed_at":"2023-11-05T02:08:31.000Z","size":571,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-11-05T03:20:04.529Z","etag":null,"topics":["accessible","docskimmer-theme","mkdocs-theme","responsive","theme"],"latest_commit_sha":null,"homepage":"https://hfagerlund.github.io/mkdocs-docskimmer/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hfagerlund.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2017-06-13T00:33:55.000Z","updated_at":"2023-11-05T02:08:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"1c922728-aa23-4585-9b83-d0188a136508","html_url":"https://github.com/hfagerlund/mkdocs-docskimmer","commit_stats":null,"previous_names":[],"tags_count":7,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fmkdocs-docskimmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fmkdocs-docskimmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fmkdocs-docskimmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fmkdocs-docskimmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hfagerlund","download_url":"https://codeload.github.com/hfagerlund/mkdocs-docskimmer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223445675,"owners_count":17146327,"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":["accessible","docskimmer-theme","mkdocs-theme","responsive","theme"],"created_at":"2024-11-07T02:24:08.787Z","updated_at":"2024-11-07T02:24:09.417Z","avatar_url":"https://github.com/hfagerlund.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docSkimmer Theme\n\n**docSkimmer** is a skimmable minimal theme for [MkDocs](https://github.com/mkdocs/mkdocs/). Supports [MkDocs versions \u003e= 0.16.2](https://github.com/hfagerlund/mkdocs-docskimmer#version-compatibility).\n\n\u003cimg style=\"max-width:100%;\" alt=\"Screenshot of docSkimmer theme for MkDocs\" src=\"/screenshots/mkdocs-docskimmer.png\" align=\"center\" /\u003e\u003cbr /\u003e\n\n*Figure 1: Screenshot of docSkimmer theme for MkDocs*\n\n## Features\n\n* accessible;\n* responsive;\n* valid HTML5 + CSS3;\n* no fonts (include only what you prefer using `extra_css`);\n* no libs - except for a single (~2KB) module (include only what you prefer using `extra_javascript`);\n* supports MkDocs configuration features such as `google_analytics`.\n\n## Installation\n\n* Clone docSkimmer from GitHub:\n\n```\n$ git clone https://github.com/hfagerlund/mkdocs-docskimmer.git\n\n```\n\nOr [download the required version](https://github.com/hfagerlund/mkdocs-docskimmer/releases) - refer to: ['Version compatibility'](https://github.com/hfagerlund/mkdocs-docskimmer#version-compatibility).\n\n(Not on PyPI yet.)\n\n* Copy the contents of the `mkdocs_docskimmer` directory into the MkDocs project root (ie. at the same level as the `docs` directory).\n\n## Usage\n\n* Modify the following settings in the 'mkdocs.yml' file:\n\n### For docSkimmer v0.3.x, v0.4.x:\n```yaml\n# mkdocs.yml:\n\nnav:\n    ## add your custom pages hierarchy here\n\ntheme:\n  name: null\n  custom_dir: 'mkdocs_docskimmer'\n  include_search_page: true\n  search_index_only: false\n  static_templates:\n  - 404.html\n\nplugins: ['search']\n\n# add theme version number here\nextra:\n    version: 0.3.x\n\n```\n\n### For docSkimmer v0.2.1:\n```yaml\n# mkdocs.yml:\n\npages:\n    ## add your custom pages hierarchy here\n\ntheme:\n  name: null\n  custom_dir: 'mkdocs_docskimmer'\n  include_search_page: true\n  search_index_only: false\n  static_templates:\n  - 404.html\n\nplugins: ['search']\n\nextra:\n    version: 0.2.1\n\n```\n\n### For docSkimmer v0.2.0:\n```yaml\n# mkdocs.yml:\n\npages:\n    ## add your custom pages hierarchy here\n\ntheme:\n    name: null\n    custom_dir: 'mkdocs_docskimmer'\n\nstatic_templates:\n    - 404.html\n\nextra:\n    version: 0.2.0\n\n```\n\n### For docSkimmer v0.1.x:\n```yaml\n# mkdocs.yml:\n\npages:\n    ## add your custom pages hierarchy here\n\ntheme_dir: 'mkdocs_docskimmer'\n```\n\n## Version compatibility\n\n| docSkimmer theme version(s) | MkDocs version(s) |\n| :------: | :------: |\n| 0.4.0 | 1.0.4 |\n| 0.3.1 | 1.0.4\u003cbr\u003e[Template URL filter addition](https://github.com/mkdocs/mkdocs/tree/decaf6141c90b0123a4b7f03ee839d0780570bc9) |\n| 0.3.0 | [Pages refactor](https://github.com/mkdocs/mkdocs/tree/34ef3ca6d0390959080ce93a695361eea1649272) |\n| 0.2.1 | 0.17.4\u003cbr\u003e0.17.3\u003cbr\u003e0.17.2\u003cbr\u003e0.17.1\u003cbr\u003e0.17.0 |\n| 0.2.0 | 0.17.0 |\n| 0.1.1\u003cbr\u003e0.1.0 | 0.16.3\u003cbr\u003e0.16.2 |\n\n## Demo\n\nA demo of the docSkimmer theme is available on its [documentation homepage](https://hfagerlund.github.io/mkdocs-docskimmer/).\n\n\n## License\nCopyright (c) 2017 Heini Fagerlund. Licensed under the [Simplified BSD License](https://github.com/hfagerlund/mkdocs-docskimmer/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfagerlund%2Fmkdocs-docskimmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhfagerlund%2Fmkdocs-docskimmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfagerlund%2Fmkdocs-docskimmer/lists"}