MkDocs
Hugo
Our great sponsors
MkDocs | Hugo | |
---|---|---|
111 | 548 | |
18,123 | 71,964 | |
1.8% | 1.3% | |
9.0 | 9.8 | |
3 days ago | 4 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
- 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.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
MkDocs Publisher as an alternative for official Obsidian publish.
For last few months, I was developing a set of plugins for MkDocs, that allows you to use GitHub Pages or GitLab Pages as a cheaper alternative to official Obsidian publish. Story behind this tool started quite long time a go, when I was using Nikola (static site tool for blogging) and Obsidian as a post editor. When Nikola stopped working for me on Apple Silicon (due to some problems with one of Python library) I started to look for a new tool. I couldn't find anything good enough and just started to work on my own plugin. From the first idea to current implementation, I build 5 plugins packed as a single Python library. As for Obsidian part, project currently supports:
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
-
Knowledge base system choice
I would also look at https://www.mkdocs.org for organising documentation esp if you are used to 'readthedocs' manuals.
Hugo
-
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
Hugo
-
Top 5 Open-Source Documentation Development Platforms of 2024
Hugo is a popular static site generator specifically designed to create websites and documentation lightning-fast. Its minimalist approach, emphasis on speed, and ease of use have made it popular among developers, technical writers, and anybody looking to construct high-quality websites without the complexity of typical CMS platforms.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Get People Interested in Contributing to Your Open Project
Create the technical documentation of your project You can use any of the following options: * A wiki, like the ArchWiki that uses MediaWiki * Read the Docs, used by projects like Setuptools. Check Awesome Read the Docs for more examples. * Create a website * Create a blog, like the documentation of Blowfish, a theme for Hugo.
-
Writing a SSG in Go
Doing this made me appreciate existing SSGs like Hugo and Next.js even more👏👏
-
Why Blogging Platforms Suck
I suggest hugo: https://gohugo.io/
Generates a completely static website from MD (and other formats) files; also handles themes (including a lot of them rendering well on mobile), and different types of content - posts, articles, etc. - depending on the theme.
It's open source and, being completely static, cheap as fuck to self host.
-
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
-
Hugo site generator theme in style of Jake's resume
I made a one-page theme for Hugo site generator that looks like Jake's resume. You can create resume page, deploy it on GitHub Pages and just print it to pdf file from browser for your needs afterwards. Demo page: https://schebotar.github.io/hugos-resume/ Repository: https://github.com/schebotar/hugos-resume
What are some alternatives?
sphinx - The Sphinx documentation generator
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
pdoc - API Documentation for Python Projects
DocFX - Static site generator for .NET API documentation.
Pelican - Static site generator that supports Markdown and reST syntax. Powered by Python.
Docusaurus - Easy to maintain open source documentation websites.
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
Hexo - A fast, simple & powerful blog framework, powered by Node.js.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
obsidian-export - Rust library and CLI to export an Obsidian vault to regular Markdown
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
SvelteKit - web development, streamlined