Docgen - a fork of Doctave intending to continue the development.

Related tags

Utilities docgen
Overview

Docgen

Docgen is a fork of Doctave intending to continue the development. All credit goes to the original Docgen authors.

Docgen is an opinionated documentation site generator that converts your Markdown files into a beautiful documentation site with minimal effort.

Docgen is not a generic static site generator - it is only meant for generating documentation sites from Markdown. This allows the tool to be much simpler than other solutions, with fewer configuration steps.

This open source tool is built and maintained by Streetwriters.co.

Features

Docgen comes with a number of documentation-specific features out of the box. No plugins needed.

  • Mermaid.js diagrams
  • Offline full-text search
  • Local live-reloading server
  • Broken links checking
  • Typesetting for mathematical formulas
  • Responsive design
  • Dark mode
  • GitHub flavored markdown
  • Minimal configuration
  • Symlinked files [new]
  • Tabs [new]
  • Static code block syntax highlighting (thanks to syntect) [new]
  • Fast build times (Docgen is built with Rust)

Hosting

Docgen-generated sites can be hosted on any static site hosting provider, such as GitHub Pages.

Screenshots

You can customize the color scheme and logo to match your own style. Below are two examples: one with Docgen's own color scheme, and another customized color scheme.

Light Dark
TBD TBD
TBD TBD

Installation

There are a few installation options for Docgen. If you would like another installation option, please open an issue for it.

Precompiled binaries

Docgen provides precompiled binaries for Mac, Linux, and Windows, which you can download from the latest release page.

Cargo (Rust package manager)

You can also use the Rust package manager, Cargo, to install Docgen. Currently Docgen is not listed on crates.io, but you can install it directly from GitHub:

$ cargo install --git https://github.com/thecodrr/docgen

Getting started

Once you have Docgen installed, you can run the init command to create an initial docs site:

$ docgen init

Then, run the serve command to preview your site locally.

$ docgen serve

Docgen | Serve
Starting development server...

Server running on http://0.0.0.0:4001/

You might also like...
oreboot is a fork of coreboot, with C removed, written in Rust.

oreboot is a downstream fork of coreboot, i.e. oreboot is coreboot without 'c'.

ZKP fork for rust-secp256k1, adds wrappers for range proofs, pedersen commitments, etc

rust-secp256k1 rust-secp256k1 is a wrapper around libsecp256k1, a C library by Peter Wuille for producing ECDSA signatures using the SECG curve secp25

A fork of V8Js re-implemented in Rust

PHP-V8Js PHP-V8Js is a PHP extension for the V8 JavaScript engine. It is a re-implementation of the fantastic (though unmaintained) V8Js PHP extension

Dav-server-rs - Rust WebDAV server library. A fork of the webdav-handler crate.

dav-server-rs A fork of the webdav-handler-rs project. Generic async HTTP/Webdav handler Webdav (RFC4918) is defined as HTTP (GET/HEAD/PUT/DELETE) plu

A fork of yew-router

Yew Router (fork) This is fork of version 0.15 of the yew-router. Motivation The main motivation behind the fork is the lack of nested router support

Noir Pay - Fork of the Light Protocol Program for local testing / optimisation.

Noir Pay v0 Built on Light Protocol Noir Pay will be directly built ontop of the Light Protocol SDK and provide users with a beautifully simple privat

The Heros NFT Marketplace Boilerplate project is designed to let users fork, customize, and deploy their own nft marketplace app to a custom domain, ultra fast.

Heros NFT on Solana The Heros NFT Marketplace Boilerplate project is designed to let users fork, customize, and deploy their own nft marketplace app t

MangoBOX is a fork and upgrade of fund-raising protocol Juicebox on Ethereum.

Mangoboxink MangoBOX is a fork and upgrade of fund-raising protocol Juicebox on Ethereum. It rewrites the logic and functions of Juicebox in the smart

Rust Shop is a fake cloud-based software company that you can fork.

RustShop RustShop is an attempt at building a template and utilities to help quickly set up and manage a production grade cloud-based system. The core

A fork of 'discord-token-botter' for rust lang.

Shahzain Botter V3(Rust) - If you were sold this tool, you have been scammed, this tool is free & open source Please DO NOT pay money for this tool A

Alternative StreamMap fork of tokio-stream

streammap-ext This is a fork of StreamMap from tokio-stream crate. The only difference between the implementations is that this version of StreamMap n

Materialize simplifies application development with streaming data. Incrementally-updated materialized views - in PostgreSQL and in real time. Materialize is powered by Timely Dataflow.
Materialize simplifies application development with streaming data. Incrementally-updated materialized views - in PostgreSQL and in real time. Materialize is powered by Timely Dataflow.

Materialize is a streaming database for real-time applications. Get started Check out our getting started guide. About Materialize lets you ask questi

A personal etude into rust software (RPG-it's more fun to debug) development: Tales of the Great White Moose

TGWM (Tales of the Great White Moose) NB: Currently compiles. Should compile and run on both 1.28.0 and 1.31.1 if the Cargo.lock files are deleted. A

A command-line tool collection to assist development written in RUST

dtool dtool is a command-line tool collection to assist development Table of Contents Description Usage Tips Installation Description Now dtool suppor

Rust development environment for Emacs
Rust development environment for Emacs

Rustic Table of Contents Rustic Intro Installation straight Compilation Faces rustc errors Rustfmt edition 2018 LSP Server Client eglot lsp-mode lsp-e

A Software Development Kit (SDK) for Zero-Knowledge Transactions

Aleo SDK The Aleo SDK is a developer framework to make it simple to create a new account, craft a transaction, and broadcast it to the network. Table

Rust, cargo and QEMU setup for multi-architecture OS development.

rust-osdev-jumpstart Rust, cargo and QEMU setup for multi-architecture OS development. Goal This repo should give you a boost in starting a bare-metal

TestSuite4 is a framework designed to simplify development and testing of TON Contracts. It includes light-weight emulator of blockchain making it easy to develop contracts.

TestSuite4 0.1.2 TestSuite4 is a framework designed to simplify development and testing of TON Contracts. It contains lightweight blockchain emulator

Local blockchain for Free TON DApp development and testing.

TON OS Startup Edition Local blockchain for Free TON DApp development and testing. Have a question? Get quick help in our channel: TON OS Startup Edit

Comments
Releases(0.1.0)
  • 0.1.0(Oct 7, 2022)

    Why Docgen?

    This is the first release after forking off of Doctave which seems to have stagnated. Even though the original author plans to move it to a separate personal repo, it seems it is on low priority. Seeing how it has stagnated, I have decided to continue this amazing project under a different name: Docgen. So "Why not just push the changes upstream?"_ Because I am taking a different approach to this project. I want this to be simple yet feature-full. Here are some infrastructural changes I have made:

    • Moved the markdown library inside the main project so it's just one repo. This allows for faster development of new features.
    • Markdown tests are now snapshot based thanks to insta.rs. This means I don't have to think about the results, just the input.
    • Do not introduce new syntax into markdown. This hasn't been completed yet. I intend to change the callouts syntax to use quotes or something else. This is absolutely necessary to allow non-docgen editors to view & edit the markdown files without all the garbage.

    With that being said, let's move on to what new features I have added.

    :star: New stuff

    1. Symlink paths are now supported. This was a trivial change but HUGE — for example, the docs for docgen now share the main README.md file.
    2. Tabs are now here. (this was the only limitation & also the reason I forked docgen). The best thing is tabs don't introduce yet another new syntax. The parser implicitly understands when you use # [Tab title](#/tab/tab-id) that you want tabs. Everything else is the same.

    :bug: Fixes & improvements

    1. Dark/light theme are now more consistent looking thanks to CSS variables.
    Source code(tar.gz)
    Source code(zip)
    docgen-0.1.0-x86_64-apple-darwin.tar.gz(3.43 MB)
    docgen-0.1.0-x86_64-pc-windows-msvc.zip(3.45 MB)
    docgen-0.1.0-x86_64-unknown-linux-musl.tar.gz(3.83 MB)
Owner
Abdullah Atta
Still trying to chart all the uncharted regions of programming.
Abdullah Atta
Noir Pay - Fork of the Light Protocol Program for local testing / optimisation.

Noir Pay v0 Built on Light Protocol Noir Pay will be directly built ontop of the Light Protocol SDK and provide users with a beautifully simple privat

0xNico 1 Feb 12, 2022
Rust Shop is a fake cloud-based software company that you can fork.

RustShop RustShop is an attempt at building a template and utilities to help quickly set up and manage a production grade cloud-based system. The core

null 55 Oct 23, 2022
A fork of 'discord-token-botter' for rust lang.

Shahzain Botter V3(Rust) - If you were sold this tool, you have been scammed, this tool is free & open source Please DO NOT pay money for this tool A

Shahzain 5 Nov 7, 2022
Alternative StreamMap fork of tokio-stream

streammap-ext This is a fork of StreamMap from tokio-stream crate. The only difference between the implementations is that this version of StreamMap n

MetalBear 5 Aug 18, 2022
A command-line tool collection to assist development written in RUST

dtool dtool is a command-line tool collection to assist development Table of Contents Description Usage Tips Installation Description Now dtool suppor

GB 310 Nov 26, 2022
Simple fake AWS Cognito User Pool API server for development.

Fakey Cognito ?? Homepage Simple fake AWS Cognito API server for development. ✅ Implemented features AdminXxx on User Pools API. Get Started # run wit

naokirin 4 Aug 30, 2022
KERI implementation in RUST, current development lead by DIF

KERIOX Introduction Features Introduction KERIOX is an open source Rust implementation of the Key Event Receipt Infrastructure (KERI) , a system desig

WebOfTrust 3 Nov 11, 2022
Rust + Yew + Axum + Tauri, full-stack Rust development for Desktop apps.

rust-yew-axum-tauri-desktop template Rust + Yew + Axum + Tauri, full-stack Rust development for Desktop apps. Crates frontend: Yew frontend app for de

Jet Li 51 Nov 30, 2022
Fork of async-raft, the Tokio-based Rust implementation of the Raft protocol.

Agreed Fork of async-raft, the Tokio-based Rust implementation of the Raft distributed consensus protocol. Agreed is an implementation of the Raft con

NLV8 Technologies 8 Jul 5, 2022
Vim-fork focused on extensibility and usability

Documentation | Chat | Twitter Neovim is a project that seeks to aggressively refactor Vim in order to: Simplify maintenance and encourage contributio

Neovim 60.1k Dec 1, 2022