MkDocs
Hugo


MkDocs | Hugo | |
---|---|---|
118 | 580 | |
19,841 | 77,837 | |
1.1% | 1.3% | |
7.9 | 9.8 | |
3 months ago | 7 days ago | |
Python | Go | |
BSD 2-clause "Simplified" License | Apache License 2.0 |
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.
MkDocs
-
How to Create and Publish a Python Package on PyPI 🐍
The original mkdocs uses a Python package for its installer, so you can just pip install mkdocs, mkdocs new ., and then mkdocs build to convert markdown files into HTML.
-
Docusaurus – Build optimized websites quickly, focus on your content
If you don't like to run javascript outside of a browser, MkDocs is a great Python-based alternative: https://www.mkdocs.org/
-
Why I Prefer RST to Markdown
I like Markdown because it's simple and doesn't give me that many headaches.
You know what I don't like? HTML, for user submitted content in particular. The mess I've seen, after someone opted for using HTML for messages in a system, because that's what JS based editors were available for at the time. Endless need to work against XSS, with more and more incremental updates needed to the sanitization logic, some of which broke the presentation of the data in the DB.
Never again. Markdown, BBCode, anything but that.
As for docs? Currently just some Markdown, because that's what GitHub, GitLab, Gitea and others all know how to render.
Maybe something like https://www.mkdocs.org/ for the more standalone use cases.
-
Why Docs-as-Code is the Key to Better Software Documentation
Developing the documentation website using an open-source static site generator like Sphinx or MkDocs to build the files locally through the command line, rather than using a commercial program.
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
Hugo
-
I Blog with Raw HTML
If you turn Javascript off, the Markdown-formatted text will not display as a clickable link, but like "[hugo](https://gohugo.io/)". You would need to copy and paste the link into a browser address bar to navigate there instead of just clicking the link.
-
Building bun-tastic: A Fast, High-Performance Static Site Server (OSS)
Static sites are a thing of beauty and simplicity. They're fast, secure, and easy to manage. The JAMStack movement help made it popular (after SPAs) and static site builders like Hugo and Eleventy are making it simple to build websites in this manner. I dare not mention Astro because it's the new kid making building static sites cooler than ever.
- How to Deploy a Static Website with Hugo and GitHub Pages
-
Setting up my writing journey
I used Hugo to convert markdown to html as with this it was very easy to do as I just did installed Hugo locally created a project added a pre-build theme and just copy-paste markdown files to content folder inside Hugo project that's it. Quickly pushed code to GitHub wrote a simple GitHub Workflow to deploy Hugo Site on GitHub Pages and That's it.
-
We switched from Next.js to Astro (and why it might interest you)
Like some other commenters here who started with Bootstrap/jQuery/etc., I feel stuck in the stone ages at times. My most recent content-based site uses Hugo (https://gohugo.io/), but I'm starting to tire of the magic and gotchas I keep running into.
Can someone that has used Astro and an older static site generator framework explain the pros/cons of Astro in that context?
-
How to Host Hugo in Vercel
I decided to go with Hugo to build my personal website. The only thing I based my choice on was the build time. I thought Hugo was in the same league as Astro when it comes to content management perks, but it isn't quite there yet. Or, I can say it has its own path since it's older than most of the other static site generators I've encountered. Moreover, it's a Go application, which is another important factor to consider when evaluating technology choices.
-
Show HN: SQLite Plugin for Jekyll
Hugo got a WASM based plugin system, but real scripting plugins that would be needed for SQLite are still a feature request: https://github.com/gohugoio/hugo/issues/5510
-
Ask HN: Best Minimal Blog Site?
https://gohugo.io/
It's written in go but what's great about it, unlike many competitors written in Javascript or Python, is that it is just a simple binary you download and run, you do not need to get a PhD in the go build system to start a web site also it is crazy fast. It can publish a site to something like S3 or Azure Storage behind a CDN and you do not have to worry about anything other than paying the storage and bandwidth bills.
Myself I've been procrastinating on getting myself a blog and my take is Hugo is not customizable enough for me without learning a lot of Go, so I have looked at are either Python-based or oriented towards scientific publishing oriented systems such as
https://getpelican.com/
https://www.sphinx-doc.org/en/master/
https://quarto.org/
(I want to write stuff like https://ontology2.com/essays/PropertiesColorsAndThumbnails.h...)
I've given this list to people in your shoes and they usually react with information overload
https://jamstack.org/generators/
part of that is that there are 355 generators (there have to be some good ones in there somewhere) but it also uses the kind of miscommunication patterns we're used to in webtech where, for instance, you'd think they are pushing Javascript down your throat (the "J" stands for Javascript but the generators I've mentioned generate mostly HTML with just a little Javascript.)
Pick something simple and run with it, if I did that 2 years ago I'd be blogging now.
-
MdBook – a command line tool to create books with Markdown
I'm satisfied with Hugo: https://gohugo.io/ It is very fast and has a lot of features. The syntax highlighting for code looks also very good.
-
Must-have apps and services in 2024
For my personal site, I use Hugo, and I host the markdown files on GitHub. Publishing is done whenever I push to the repository using Netlify.
What are some alternatives?
sphinx - The Sphinx documentation generator
toxiproxy - :alarm_clock: :fire: A TCP proxy to simulate network and system conditions for chaos and resiliency testing
pdoc - API Documentation for Python Projects
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
DocFX - Static site generator for .NET API documentation.
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Postman - CLI tool for batch-sending email via any SMTP server.
Docusaurus - Easy to maintain open source documentation websites.
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.

