sphinx
Jekyll
Our great sponsors
sphinx | Jekyll | |
---|---|---|
31 | 253 | |
6,032 | 48,287 | |
1.3% | 0.6% | |
9.8 | 8.7 | |
2 days ago | 3 days ago | |
Python | Ruby | |
GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
sphinx
-
5 Best Static Site Generators in Python
Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.
-
User Guides in Code Documentation: Empowering Users with Usage Instructions
Sphinx a documentation generator or a tool that translates a set of plain text source files into various output formats, automatically producing cross-references, indices, etc. That is, if you have a directory containing a bunch of reStructuredText or Markdown documents, Sphinx can generate a series of HTML files, a PDF file (via LaTeX), man pages and much more.
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Notable mentions to [Sphinx](https://www.sphinx-doc.org/). It's workflow is more tuned to the "book" format rather than the blog, forum or thread format.
-
best packages for documenting the flow of logic?
Currently trying out Sphinx (https://www.sphinx-doc.org) and the trying to get the autodocgen feature to see what that can do.
-
Generate PDF from file (docstrings)
So, I've documented my code and now I need a .PDF with this documentation. Is there any easy way to do it? Once I used Sphinx but it generated a not so easy .TeX.
-
Introducing AutoPyTabs: Automatically generate code examples for different Python versions in MkDocs or Sphinx based documentations
AutoPyTabs allows you to write code examples in your documentation targeting a single version of Python and then generates examples targeting higher Python versions on the fly, presenting them in tabs, using popular tabs extensions. This all comes packaged as a markdown extension, MkDocs plugin and a Sphinx, so it can easily be integrated with your documentation workflow.
-
dictf - An extended Python dict implementation that supports multiple key selection with a pretty syntax.
Honestly, I think it's just an issue of documentation. For example, if there was an easier way to document @overload functions, that would help (cf. https://github.com/sphinx-doc/sphinx/issues/7787)
-
Pipeline documentation
We use sphynx for our pipeline documentation for all technical details Classes , packages and functions docstrings using reStructuredText (reST) format
-
Minimum Viable Hugo – No CSS, no JavaScript, 1 static HTML page to start you off
I like Sphinx [0] with the MyST Markdown syntax [1]. There is a related project, Myst NB [2], which enables including Jupyter notebooks in your site. There is also a plugin for blogging [3].
[0]: https://www.sphinx-doc.org
-
Marketing for Developers
Sphinx is the go-to tool for documentation. It took me a while to understand how to use Sphinx, but I now have a decent workflow with MyST which allows me to write all the docs in markdown. My sphinx-markdown-docs repo shows an example of what I do.
Jekyll
-
Creating excerpts in Astro
This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.
-
Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
Jekyll
-
Ask HN: Looking for lightweight personal blogging platform
In future, if you want to move from Jekyll to something else, you just have to worry about that `_posts` and `_assets` folder. They may have different naming convention but you can just config-managed it or change it to your choice. This is why I suggested owning that two yourself.
You also may not worry about FrontMatter[3] (meta in the header) and its accompanying jazz by asking Jekyll to use the plugins `jekyll-optional-front-matter` and `jekyll-titles-from-headings`. These comes as part of the officially supported Jekyll plugins[4] by Github. That way, you are just writing a human-readable plain-text spiced up with Markdown and readable by almost every other Static Site Generator.
Now, play with the `_config.yml` that Jekyll generates for you from the theme above to define your post dates, navigation, and others. Jekyll is one of the OGs — the Gandalf of Static Site Generators. If you have a problem, someone somewhere has solved that.
Did I missed something? I was supposed to write a blog article for my website on this one and this comment will serve as my starting bullet points.
1. https://docs.github.com/en/pages/setting-up-a-github-pages-s...
2. https://jekyllrb.com
3. https://frontmatter.codes/docs/markdown
4. https://docs.github.com/en/pages/setting-up-a-github-pages-s...
-
Where are the layouts!? And where is the site object loaded from? (Chirpy Theme)
"Using the Chirpy theme for Jekyll."
-
Any FOSS to make HTML websites for self-hosting?
I would suggest looking into static site generators. Some popular examples, which are used myself are: - Hugo: https://gohugo.io/ - Jekyll: https://jekyllrb.com
- How do i replicate GTFOBins layout ?
- Release v4.3.2 · jekyll/jekyll
-
How To Choose the Best Static Site Generator and Deploy it to Kinsta for Free
In terms of GitHub stars, SSGs like Next.js, Hugo, Gatsby, Docusaurus, Nuxt.js, and Jekyll top the list. Some popular SSGs even host conferences and workshops, providing resources and networking opportunities for those looking to explore more advanced topics in depth.
-
How to run Jekyll on Kubernetes
I created my blog using Jekyll, a great open-source tool that can transform your markdown content into a simple, old-fashioned-but-trendy, static site. What are the advantages of this approach? The site is super-light, super-fast, super-secure and SEO-friendly. Of course, it’s not always the best solution, but for some use cases, like a simple personal blog, it’s really a good option.
-
AWS Customers Cannot Escape IPv4
Yes, it's Markdown and I use https://jekyllrb.com with the theme "jekyll-theme-hacker" to generate the site. I quite like how simple it is.
What are some alternatives?
MkDocs - Project documentation with Markdown.
Hugo - The world’s fastest framework for building websites.
pdoc - API Documentation for Python Projects
Middleman - Hand-crafted frontend development
Pycco - Literate-style documentation generator.
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
Bridgetown - A next-generation progressive site generator & fullstack framework, powered by Ruby
mkdocs-material - Documentation that simply works
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
Python Cheatsheet - All-inclusive Python cheatsheet
Lektor - The lektor static file content management system