{"id":13512365,"url":"https://github.com/pradyunsg/furo","last_synced_at":"2025-05-14T21:02:19.152Z","repository":{"id":37940589,"uuid":"292107856","full_name":"pradyunsg/furo","owner":"pradyunsg","description":"A clean customizable documentation theme for Sphinx","archived":false,"fork":false,"pushed_at":"2025-05-05T21:32:01.000Z","size":8190,"stargazers_count":3059,"open_issues_count":46,"forks_count":339,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-05-07T19:47:43.102Z","etag":null,"topics":["clean","customizable","documentation","furo","minimal","sphinx","sphinx-doc","sphinx-theme","theme","three-column"],"latest_commit_sha":null,"homepage":"https://pradyunsg.me/furo/quickstart","language":"Sass","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/pradyunsg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/design.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2020-09-01T21:08:17.000Z","updated_at":"2025-05-07T06:03:30.000Z","dependencies_parsed_at":"2023-02-16T15:15:18.881Z","dependency_job_id":"d762e2d1-334a-41a6-9b99-b746e221db58","html_url":"https://github.com/pradyunsg/furo","commit_stats":{"total_commits":1385,"total_committers":52,"mean_commits":"26.634615384615383","dds":"0.11407942238267144","last_synced_commit":"fd3e7b94e9959870aa3c8efb221de66be923421d"},"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pradyunsg%2Ffuro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pradyunsg%2Ffuro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pradyunsg%2Ffuro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pradyunsg%2Ffuro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pradyunsg","download_url":"https://codeload.github.com/pradyunsg/furo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227605,"owners_count":22035668,"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":["clean","customizable","documentation","furo","minimal","sphinx","sphinx-doc","sphinx-theme","theme","three-column"],"created_at":"2024-08-01T03:01:46.967Z","updated_at":"2025-05-14T21:02:18.567Z","avatar_url":"https://github.com/pradyunsg.png","language":"Sass","funding_links":[],"categories":["Sass","documentation","Site Generators","HarmonyOS"],"sub_categories":["Sphinx Themes","Windows Manager"],"readme":"\u003ch1 align=\"center\"\u003eFuro\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  A clean customisable \u003ca href=\"https://www.sphinx-doc.org/\"\u003eSphinx\u003c/a\u003e documentation theme.\n\u003c/p\u003e\n\u003ca href=\"https://pradyunsg.me/furo/\"\u003e\n  \u003cimg align=\"center\" src=\"https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png\" alt=\"Demo image\"\u003e\n\u003c/a\u003e\n\n## Elevator pitch\n\n\u003c!-- start elevator-pitch --\u003e\n\n- **Intentionally minimal** --- the most important thing is the content, not the scaffolding around it.\n- **Responsive** --- adapting perfectly to the available screen space, to work on all sorts of devices.\n- **Customisable** --- change the color palette, font families, logo and more!\n- **Easy to navigate** --- with carefully-designed sidebar navigation and inter-page links.\n- **Good looking content** --- through clear typography and well-stylised elements.\n- **Good looking search** --- helps readers find what they want quickly.\n- **Biased for smaller docsets** --- intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming.\n\n\u003c!-- end elevator-pitch --\u003e\n\n## Quickstart\n\n\u003c!-- start quickstart --\u003e\n\nFuro is distributed on [PyPI]. To use the theme in your Sphinx project:\n\n1. Install Furo in documentation's build environment.\n\n   ```text\n   pip install furo\n   ```\n\n2. Update the `html_theme` in `conf.py`.\n\n   ```py\n   html_theme = \"furo\"\n   ```\n\n3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉\n\n[pypi]: https://pypi.org/project/furo/\n\n\u003c!-- end quickstart --\u003e\n\nFor more information, visit [Furo's documentation][quickstart-docs].\n\n[quickstart-docs]: https://pradyunsg.me/furo/quickstart\n\n## Contributing\n\nFuro is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our [Contributing Guide](https://pradyunsg.me/furo/contributing/) for more information.\n\n## Acknowledgements\n\nFuro is inspired by (and borrows elements from) some excellent technical documentation themes:\n\n- [mkdocs-material] for MkDocs\n- [Just the Docs] for Jekyll\n- [GitBook]\n- [pdoc3]\n\nWe use [BrowserStack] to test on real devices and browsers. Shoutout to them for supporting OSS projects!\n\n[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/\n[just the docs]: https://just-the-docs.github.io/just-the-docs/\n[gitbook]: https://www.gitbook.com/\n[pdoc3]: https://pdoc3.github.io/pdoc/doc\n[browserstack]: https://browserstack.com/\n\n## What's with the name?\n\nI plucked this from the scientific name for [Domesticated Ferrets](https://en.wikipedia.org/wiki/Ferret): Mustela putorius **furo**.\n\nA ferret is actually a really good spirit animal for this project: cute, small, steals little things from various places, and hisses at you when you try to make it do things it doesn't like.\n\n\u003e I plan on commissioning a logo for this project (or making one myself) consisting of a cute ferret. Please reach out if you're interested!\n\n## Used By\n\n\u003c!-- start used-by --\u003e\n\n\u003e I'm being told that mentioning who uses `$thing` is a good way to promote `$thing`.\n\n- [urllib3] -- THE first adopter of Furo\n- [attrs] -- one of the early adopters!\n- [pip] -- what I wrote this for\n- [Python Developer’s Guide][devguide]\n- [black]\n\n[urllib3]: https://urllib3.readthedocs.io/\n[attrs]: https://www.attrs.org/\n[devguide]: https://devguide.python.org/\n[pip]: https://pip.pypa.io/\n[psycopg3]: https://www.psycopg.org/psycopg3/docs/\n[black]: https://black.readthedocs.io/en/stable/\n[pelican]: https://docs.getpelican.com/en/latest/\n\n\u003c!-- end used-by --\u003e\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradyunsg%2Ffuro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpradyunsg%2Ffuro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpradyunsg%2Ffuro/lists"}