Docuowl generates static single-page documentation from Markdown files. As a long-time fan of the documentation style made by Stripe, and Markdown, I decided to use the former as a base to create a pretty documentation generator that outputs something like Stripe's. Stripe also generously allowed me to use their layout, so here's a big thank you to them". Docuowl takes a directory as input. The directory is expected to have one directory for each section or group. Each group may have subsections, which by their turn must also be placed into directories. Each Section is required to have content.md file, containing the Frontmatter for that section, and optional sidenotes.md file, that will be rendered to the right of the section. The Frontmatter must contain at least a Title property, and an optional ID property containing a unique slug for that section. Each Group must contain a single meta.md file, containing a Frontmatter like a Section, and an optional content.

Features

  • Docuowl introduces two new blocks to Markdown: Boxes and Attributes List
  • Attributes Lists can only be used in contents
  • Docuowl can be invoked in two modes: Compile, and Watch
  • Watch allows one to continuously write documentation and see the preview with auto-reload
  • In order to locally build, use the provided Makefile
  • This software uses other open-source components

Project Samples

Project Activity

See All Activity >

Categories

Documentation

License

MIT License

Follow Docuowl

Docuowl Web Site

Other Useful Business Software
Compliant and Reliable File Transfers Backed by Top Security Certifications Icon
Compliant and Reliable File Transfers Backed by Top Security Certifications

Cerberus FTP Server delivers SOC 2 Type II certified security and FIPS 140-2 validated encryption.

Stop relying on non-certified, legacy file transfer tools that creak under the weight of modern security demands. Get full audit trails, advanced access controls and more supported by an award-winning team of experts. Start your free 25-day trial today.
Start Free Trial
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Docuowl!

Additional Project Details

Programming Language

Go

Related Categories

Go Documentation Software

Registered

2022-09-08