docsify
MkDocs
Our great sponsors
- Appwrite - The open-source backend cloud platform
- Sonar - Write Clean JavaScript Code. Always.
- Onboard AI - Learn any GitHub repo in 59 seconds
- InfluxDB - Collect and Analyze Billions of Data Points in Real Time
- Revelo Payroll - Free Global Payroll designed for tech teams
docsify | MkDocs | |
---|---|---|
28 | 107 | |
25,054 | 17,101 | |
2.2% | 0.8% | |
8.8 | 8.9 | |
6 days ago | 10 days ago | |
JavaScript | Python | |
MIT License | BSD 2-clause "Simplified" 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.
docsify
-
Cookbook for SH-Beginners. Any interest? (building one)
Good idea. Instead of bookstack, I recommend something like Docsify The content is all in Markdown and can be managed in a git repo. Easy to deploy the whole website to any simple static HTTP server - or even Github pages. This way you can review contributions and have good version control.
okay new plan, does anyone know how to do this docsify on github? i obviously am a noob on github and recently on reddit. I'd like to help where i can but my knowlegde seems to be my handycap. i could provide you a trash-mail, if you need one, but i need a PO (product owner) to manage the git... i have no clue about this yet (pages and functions and stuff)
- Docsify.js single-page apps are indexable on Google!
- Library / CMS / framework for documentation?
-
How to Build a Personal Webpage from Scratch (In 2022)
Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown.
-
Example of Support Guide for End Users
If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages.
- Show HN: Markdown as Web Page/Site
-
Phabricator replacement? | Or OpenProject alternative? | issue tracking/code
*Leantime - Competitor to OP? Updated recently, uses Docsify, no demo :(
-
I'm a co-founder of an IT agency, and I need help with new ideas.
There are a lot of open-source projects that can help businesses to save time and money. For example, we created a Free Admin panel a few months ago https://github.com/altence/lightence-admin That's an example of free documentation generator https://github.com/docsifyjs/docsify There are a lot more examples. And I want to find an idea of some similar generic solutions that can help various types of businesses
That's my question also :) There are a lot of open-source projects that can help businesses to save time and money. For example, we created a Free Admin panel a few months ago https://github.com/altence/lightence-admin That's an example of free documentation generator https://github.com/docsifyjs/docsify
MkDocs
-
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.
-
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.
-
What software do you use to write documentation?
I use mkdocs: https://www.mkdocs.org/
- Welcome to the PyPI Blog
-
MoriiVTT; open-source half-vtt I've been working on
Regarding documentation, I have started using mkdocs (https://www.mkdocs.org/). I like it because it's markdown, and it's very easy to add to your project. Basically a /docs folder, and one configuration file in the project root, and you can have your CI build and publish the documentation to a website on git push.
What are some alternatives?
sphinx - The Sphinx documentation generator
DocFX - Static site generator for .NET API documentation.
Hugo - The world’s fastest framework for building websites.
pdoc - API Documentation for Python Projects
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
VuePress - 📝 Minimalistic Vue-powered static site generator
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
Pycco - Literate-style documentation generator.