{"repo":"DannyBen/madness","free":true,"listed":false,"github":"https://github.com/DannyBen/madness","clone":"git clone https://github.com/DannyBen/madness.git","description":"Instant Markdown Server","language":"Ruby","stars":172,"topics":["markdown-to-html","markdown","documentation-tool","markdown-server","gem","ruby"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Madness - Instant Markdown Server Madness is a command line server for rendering markdown documents in your browser. It is designed to facilitate easy development of internal markdown-based documentation sites. Screenshots Install Using Ruby: Using Homebrew: Using Docker: Feature Highlights - Easy to use. - Built-in full text search. - Compatible with how markdown files are displayed on GitHub and GitHub pages. - Configure with a configuration file or command arguments. - Fully customizable theme. - Built-in light and dark theme support. - Automatic generation of navigation sidebar. - Automatic generation of Table of Contents (site-wide and per page). - Can optionally show additional file types in the navigation menu (e.g. PDF files). - Optional support for [[Short Link]] syntax. - Optional support for Mermaid diagrams. - Optional basic authentication. - Support for extended markdown syntax, such as footnotes and syntax highlighting. Usage Go to any directory that contains markdown files and run: And open in your browser. For more options, run: Directory Conventions Madness expects to be executed in a documentation directory. A documentation directory contains only markdown files ( .md ) and sub directories that contain more markdown files. The navigation sidebar will show all the sub directories and files in the same directory as the viewed file. Example structure: Configuration File Madness uses sensible defaults, so therefore can be executed without configuring anything. C","default_branch":null,"files":null,"tree":[],"storefront":"/r/DannyBen","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/DannyBen/madness/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}