https://github.com/abd-01/furo50
A sphinx extension that turns Furo theme into CS50's theme.
https://github.com/abd-01/furo50
cs50 cs50x python sphinx sphinx-extension sphinx-theme
Last synced: 10 months ago
JSON representation
A sphinx extension that turns Furo theme into CS50's theme.
- Host: GitHub
- URL: https://github.com/abd-01/furo50
- Owner: ABD-01
- License: gpl-3.0
- Created: 2024-07-17T14:08:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-11T07:51:31.000Z (about 1 year ago)
- Last Synced: 2025-09-19T22:26:33.415Z (10 months ago)
- Topics: cs50, cs50x, python, sphinx, sphinx-extension, sphinx-theme
- Language: Python
- Homepage: https://abd-01.github.io/furo50/
- Size: 3.16 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Furo50
A sphinx extension that turns Furo theme into CS50's theme.
## Prerequisites
To use this extension you will need [Furo][furo link] theme for your project.
Install [furo][furo link] theme and update html_theme in the [sphinx configuration][conf link]
## Usage
1. Install Furo50 extension in your sphinx environment.
```
pip install furo50
```
2. In the [`conf.py`][conf link] configuration file, add [furo50][furo50 link] to the extensions list.
```
extensions = [
...
'furo50'
...
]
```
Your Sphinx documentation’s HTML pages will now be generated with this [CS50][cs50 link] theme! 🎉
## Features
* **CS50-Inspired Design**: Emulates the look and feel of [CS50][cs50 link]'s course pages.
* **Easy Configuration**: Simple configuration addition needed in conf.py for quick setup and customization.
* **Syntax Highlighting**: Incorporates CS50-style syntax highlighting for code blocks, improving code readability.
* **Sidebar Styles**: Offers both crimson (CS50) and black (CS50X) sidebar options, allowing users to choose their preferred aesthetic.
* **Seamless Furo Integration**: Built on top of the Furo theme, and is compatible with Furo's existing features and customizations.
* and more ...
## Changelog
Visit [furo50/changelog](https://abd-01.github.io/furo50/changelog/)
## Licence
Copyright © 2024, Muhammed Abdullah
This software is made available under the GPL v3.
[furo link]: https://pradyunsg.me/furo/
[furo50 link]: https://github.com/ABD-01/furo50
[cs50 link]: https://cs50.harvard.edu/college/2019/fall/
[conf link]: https://www.sphinx-doc.org/en/master/usage/configuration.html