Skip to content

feat(docs): Add Furo50 Sphinx theme extension (CS50 Jekyll-style replication) #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

ABD-01
Copy link

@ABD-01 ABD-01 commented Jun 10, 2025

This PR introduces furo50, a Sphinx extension that replicates the CS50 Jekyll theme for the CS50 documentation.
The changes are minimal, ensuring compatibility with existing docs while enhancing the visual consistency.
You can preview the updated documentation at abd-01.github.io/cs50-docs.

Key features:

  • Mirrors CS50’s Jekyll theme for a cohesive look.
  • Lightweight and maintainable, built on Sphinx.

Applied in my own portfolio and Flask-Protobuf project.

I’d be happy to extend this to other CS50 tools like check50 or compare50 if needed. Please let me know any feedback or additional changes required.

Additionally, I sent an email to Professor Malan from [email protected] with details about this contribution and a humble request. Could you kindly review that email as well? Thank you for considering this PR and for the incredible work on CS50!

]

html_css_files = [
"/_static/custom.css?" + str(round(time.time())),
"https://use.fontawesome.com/releases/v5.13.0/css/all.css"
"custom.css",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The theme automatically adds the cache versioning so we no longer have to do it manually.
image
image

@@ -1,3 +1,3 @@
# `cs50/cli`
# cs50/cli
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The backtick for titles is removed due to issue: ABD-01/furo50#11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant