{"repo":"pradyunsg/furo","free":true,"listed":false,"github":"https://github.com/pradyunsg/furo","clone":"git clone https://github.com/pradyunsg/furo.git","description":"A clean customizable documentation theme for Sphinx","language":"Sass","stars":3567,"topics":["sphinx-doc","sphinx-theme","clean","minimal","three-column","customizable","sphinx","theme","furo","documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Furo A clean customisable Sphinx documentation theme. Elevator pitch - Intentionally minimal --- the most important thing is the content, not the scaffolding around it. - Responsive --- adapting perfectly to the available screen space, to work on all sorts of devices. - Customisable --- change the color palette, font families, logo and more! - Easy to navigate --- with carefully-designed sidebar navigation and inter-page links. - Good looking content --- through clear typography and well-stylised elements. - Good looking search --- helps readers find what they want quickly. - Biased for smaller docsets --- intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming. Quickstart Furo is distributed on [PyPI]. To use the theme in your Sphinx project: 1. Install Furo in documentation's build environment. 2. Update the html theme in conf.py . 3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉 [pypi]: https://pypi.org/project/furo/ For more information, visit [Furo's documentation][quickstart-docs]. [quickstart-docs]: https://pradyunsg.me/furo/quickstart Contributing Furo is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our Contributing Guide for more information. Acknowledgements Furo is inspired by (and borrows elements from) some excellent technical documentation themes: - [mkdocs-material] for MkDocs - [Just the Docs] for Jekyll -","default_branch":null,"files":null,"tree":[],"storefront":"/r/pradyunsg","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pradyunsg/furo/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}