Skip to content

Documentation

September 29, 2023
June 17, 2015

docusaurus
gitbook
nextjs#Nextra
static-sites#Eleventy/11ty
static-sites#VitePress
static-sites#VuePress

Documentation

Is Your Product's Documentation Good Enough?
How to write self-documenting code | Kislay Verma

Welcome to our community! — Write the Docs
Markdown vs. alternatives for software documentation | InfoWorld

Doxygen: Main Page
Doxygen Manual: Special Commands
Doxygen Manual: XML Commands

Natural Docs

Fundoc — command-line utility in Rust // Lib.rs

This Is Why Most Software Engineers Don’t Write Documentation | by Emanuel Marques | Mar, 2021 | Better Programming
Why programmers don’t write documentation | Kislay Verma rebuttal

Live Generation

Flatdoc
DocumentUp

Front Matter

The CMS running in VS Code for your static sites | Front Matter
Front Matter - Visual Studio Marketplace

mdBook

rust-lang/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust
mdBook - mdBook Documentation

[for review] multi-language mdbook by gambhiro · Pull Request #200 · rust-lang/mdBook internals

Alternative Backends - mdBook Documentation
mdbook-epub - Cargo: packages for Rust

Preprocessors - mdBook Documentation
Support ebooks and pdf export · Issue #88 · rust-lang/mdBook new renderer?

badboy/mdbook-mermaid
provide mermaidjs rendering · Issue #762 · rust-lang/mdBook
mdbook-plantuml - Cargo: packages for Rust
lzanini/mdbook-katex: Rust preprocessor for mdBook, converting KaTex equations to HTML.
dylanowen/mdbook-confluence

Search Results for 'mdbook' - Cargo: packages for Rust

Makua

Markua Markdown for eBook, designed by Leanpub
markua-html5-mapping/manuscript.txt at master · markuadoc/markua-html5-mapping
MarkuaPad
Books in Browsers 2014: Peter Armstrong, LeanPub - YouTube

MkDocs

MkDocs
Deploying Your Docs - MkDocs can use file://

MkDocs Is The Perfect Open Source Documentation Software
Build Your Python Project Documentation With MkDocs – Real Python
MkDocs Markdown Reference | Markdown Guide

Material for MkDocs
squidfunk/mkdocs-material: Documentation that simply works

Create a MkDocs website (like this one) - ABP Computing @ CERN

Markdown (generic)

portray

NiklasRosenstein/pydoc-markdown: Create Python API documentation in Markdown format.

Geemili/mdproof: A standalone markdown to PDF converter

Product Docs Alongside Product Code (with Next.js) with Unified and Github Actions

reStructuredText

Sphinx
Sphinx Developer’s Guide

Welcome to Sphinx-Gallery’s documentation!

dicom-containers/pydicom-docs at master · pydicom/dicom-containers container to build Sphinx docs

reStructuredText
reStructuredText Primer — Sphinx documentation

Sphinx & Read the Docs - YouTube

Socrates real time editor

Asciidoc

AsciiDoc Home Page asciidoc/asciidoc
Asciidoc guide from elastic/docs
AsciiDoc Writer’s Guide | Asciidoctor
AsciiDoc cheatsheet

Asciidoctor | An open source implementation of AsciiDoc in Ruby
asciidoctor/docker-asciidoctor: A Fedora-based Docker container for using the Asciidoctor toolchain to process AsciiDoc content

Using AsciiDoc and Asciidoctor to write documentation - Tutorial

textile

Textile Markup Language Documentation
default markup language in Redmine
RedmineTextFormattingTextile - Redmine

Slate

Introduction – API Reference
slatedocs/slate: Beautiful static documentation for your API

Mermade/reslate: Beautiful static documentation for your API Slate with 11ty

apispec

apispec documentation with plugin for Flask and bottle

Documenting your Flask-powered API like a boss - DEV Community 👩‍💻👨‍💻

Artifact

vitiral/artifact: The open source design documentation tool for everybody
Introduction - Simple Quality with Artifact

Artifact 2.0 Rust Full Stack Web And Cli Application

JavaScript

reactjs#Documentation

Let's talk JS ⚡: documentation

Use JSDoc: Index
Jsdoc cheatsheet
Extend JSDoc API documentation through tutorials – FusionBrew – The FusionCharts Blog
An introduction to JSDoc - DZone Web Dev
Type Safe JavaScript with JSDoc - TruckJS - Medium
Documenting JavaScript APIs with JSDoc — LSST DM Developer Guide Current documentation

webdoc - Home
webdoc-labs/webdoc: Documentation generator for the web

daux.io output html, confluence or html-file
docsify renders Markdown dynamically
documentationjs
docpress
ESDoc - A Good Documentation Generator for JavaScript | esdoc-site
SoftwareBrothers/better-docs: Beautiful theme/template for jsdoc generated documentation - with category plugin

C

XML documentation comments - document APIs using /// comments | Microsoft Docs
Recommended XML documentation tags for a class and its members | Microsoft Docs

Doxygen supports document generation with XML commands
Doxygen Manual: XML Commands
c# - Visual Studio with DoxyGen for documentation, or should we use something else? - Stack Overflow

/// <summary>
/// This property always returns a value &lt; 1.
/// </summary>
class ABC {
}

manpage

kapouer-marked-man · GitHub
Mantastic - manpage generator and manager
Unix and Node: Manual Pages

greg-js/markdown2troff
kapouer/marked-man: markdown to roff wrapper around marked