{"id":20425044,"url":"https://github.com/databio/mkdocs-databio","last_synced_at":"2026-03-03T22:32:57.167Z","repository":{"id":40348639,"uuid":"164706927","full_name":"databio/mkdocs-databio","owner":"databio","description":"Lab theme for mkdocs","archived":false,"fork":false,"pushed_at":"2023-11-30T16:36:42.000Z","size":1379,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-09-11T10:15:31.321Z","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":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/databio.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-08T18:13:03.000Z","updated_at":"2022-05-13T16:57:08.000Z","dependencies_parsed_at":"2024-11-15T07:12:11.603Z","dependency_job_id":"57500f4b-7400-4a86-abf5-47999d3271bc","html_url":"https://github.com/databio/mkdocs-databio","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/databio/mkdocs-databio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databio%2Fmkdocs-databio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databio%2Fmkdocs-databio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databio%2Fmkdocs-databio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databio%2Fmkdocs-databio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/databio","download_url":"https://codeload.github.com/databio/mkdocs-databio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databio%2Fmkdocs-databio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30064357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"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":[],"created_at":"2024-11-15T07:12:07.325Z","updated_at":"2026-03-03T22:32:57.146Z","avatar_url":"https://github.com/databio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs databio theme and plugin\n\nThis repository contains the [mkdocs](http://mkdocs.org) theme and plugin for the [Sheffield lab](http://databio.org/):\n\n- **Theme:** The theme is just a lab style so that all our documentation matches.\n- **Plugin:** The plugin is a mkdocs plugin that allows us to auto-document Python code using lucidoc, which produces markdown documentation that is naturally hosted by mkdocs.\n\nInstalling this will give you access to both for your mkdocs repositories.\n\n## Install\n\nInstall it with:\n\n```{bash}\npip install --user --upgrade https://github.com/databio/mkdocs-databio/zipball/master\n```\n\n## Hello World example\n\nYou can run the example in the [example](/example) folder by running this after cloning this repo:\n\n```\ncd example\nmkdocs serve\n```\n\nYou can use this as a template; copy/paste the contents of the `example` folder into your root repository directory and then edit away!\n\n## Enabling the theme\n\nThe theme refers to the look and feel of the site. It contains the software that renders the hierarchial sidebar, the different navbar links, etc. Use it for your site by adding this to your `mkdocs.yml` file:\n\n\n```{yaml}\ntheme: databio\n```\n\n## Enabling the plugin\n\nThe plugin is used to autodocument python modules, to include jupyter notebooks, and to autodocument CLI usage. You can enable it with:\n\n```\nplugins:\n  - databio\n```\n\nThen, there are a bunch of config options:\n\n```{yaml}\nplugins:\n  - databio:\n      jupyter_source: \"docs_jupyter\"\n      jupyter_build: \"docs_jupyter/build\"\n      autodoc_package: null\n      autodoc_build: \"docs_build\"\n      docstring_style: \"rst\"\n      usage_template: \"docs/usage_template.md\"\n      usage_cmds:\n        -\"$CODEBASE/AIList/bin/AIList --help\"\n\n```\n\n\n## How to use it\n\nPut all your `.md` files into the `docs` folder, and put all your `.ipynb` files into the `docs_jupyter` folder. With the theme and plugin enabled, you can now refer to any of these files with links. The `ipynb` files will be converted into `md` files with the same name.\n\n\n## Contributing\nIf you'd like to contribute to development but are unfamiliar with `MkDocs` plugins, you can refer to the [\"Developing Plugins\" section](https://www.mkdocs.org/user-guide/plugins/#developing-plugins) of the `MkDocs` user guide.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabio%2Fmkdocs-databio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatabio%2Fmkdocs-databio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabio%2Fmkdocs-databio/lists"}