MkDocs
VuePress
Our great sponsors
MkDocs | VuePress | |
---|---|---|
111 | 44 | |
18,123 | 22,284 | |
1.8% | 0.5% | |
9.0 | 4.1 | |
4 days ago | 8 days ago | |
Python | JavaScript | |
BSD 2-clause "Simplified" License | 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.
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.
VuePress
-
Free project idea - documentation framework!
VuePress - when I searched if it's supporting what I want (conditional rendering), the first result is a bug issue opened 4 years ago, so it doesn't seem to be a good option.
-
Using links in markdown to navigate files through directories.
I'm new to IA Writer, and I'm wanting to use it to draft posts for my Vuepress site.
-
Create a Static Site using VitePress for Beautiful Help Documentation
VitePress is listed in the documents as VuePress' little brother, and it is built on top of Vite. For those that don't know Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects so it might sense to pair it with a static site generator such as VitePress. One of the original problems with VuePress was that it was a Webpack app and it took a lot of time to spin up a dev server for just a simple doc. VitePress solves these problems with nearly instant server start, an on-demand compilation that only compiles the page being served, and lightning-fast HMR. Let's get started!
-
10+ Must Use Static Site Generator 2022
VuePress
-
Do you use Vue for smaller static sites?
Definitely check out Vuepress for smaller static sites. We use it to publish our tutorials
-
Getting Tailwind to Work with Elm Book
Trying to help build a design system at work in my spare time; no clue if it will go anywhere but it’s fun regardless. I asked the Elm Slack group what the equivalent of React Storybook. Specifically, I wanted a way to build a documentation website like Vuepress with the ability to host native Elm code to showcase components. They pointed me to Elm Book. While Elm Book has built-in theming capabilities, I needed CSS control over my components. While they support elm-css, I wanted the ability to use TailwindCSS. The Elm libraries haven’t kept up with Tailwind’s changes, which is fine; writing raw Tailwind CSS on Elm HTML functions is easy and co-located with the component you’re styling.
-
How to Collect Documentation Statistics in Vuepress
Vuepress is a minimalistic static site generator with a Vue-powered theming system and a default theme that has been optimized for writing technical documentation.
-
Vue 3 comp api autogenerated component docs
You can use auto-import or Vue-Press. You can reference my-project using the auto-import plugin
-
Easy Way to Integrate Algolia to VuePress Application
This parameter is default and there is a issue.
What are some alternatives?
sphinx - The Sphinx documentation generator
pdoc - API Documentation for Python Projects
DocFX - Static site generator for .NET API documentation.
Hugo - The world’s fastest framework for building websites.
Docusaurus - Easy to maintain open source documentation websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Read the Docs - The source code that powers readthedocs.org
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mkdocs-material - Documentation that simply works
Pycco - Literate-style documentation generator.