Madness - Instant Markdown Server
Screenshots (click to zoom)
Table of Contents
- Design Intentions
- Feature Highlights
- Directory Conventions
- Configuration File
- Images and Static Files
- Automatic H1
- Table of Contents Generation
- Hidden Directories
- Controlling Sort Order
- Basic Authntication
- Customizing Theme
- Forcing HTTPS Connection
- Docker Image
$ gem install madness
$ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness'
Madness was designed in order to provide easy browsing, viewing and searching for local, markdown based documentation directories.
- 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.
- Automatic generation of navigation sidebar.
- Automatic generation of Table of Contents.
Go to any directory that contains markdown files and run:
And open http://localhost:3000 in your browser.
For more options, run:
$ madness --help
Madness expects to be executed in a documentation directory.
A documentation directory contains only markdown files (
sub directories that contain more markdown files.
The server will consider the file
README.md in any directory
as the main file describing this directory, where
index.md has priority.
The navigation sidebar will show all the sub directories and files in the same directory as the viewed file.
./ ├── README.md ├── File.md ├── Another File.md ├── Folder │ ├── File.md │ └── image.png └── Another Folder ├── README.md └── File.md
All the command line arguments can also be configured through a
configuration file. Create a file named
.madness.yml in your
documentation directory, and modify any of the settings below.
# .madness.yml path: '.' port: '3000' bind: '0.0.0.0' sidebar: true auto_h1: true auto_nav: true highlighter: true line_numbers: true copy_code: true index: false search_limit: 100 dtoc: Table of Contents theme: _theme open: false
For convenience, you can get a template config file by running:
$ madness create config
Madness comes with a full text search page. To activate it, you need to
generate a search index by running
madness --index or
madness path/to/docs --index.
This will create an
_index sub folder, and will add a new search page
to your documentation server.
You will need to run this command from time to time, as your documents change or new documents are added.
Images and Static Files
You can put images and other asset files anywhere in your documentation folder.
When linking to other pages or images in your documentation folder, simply use the URL relative to the markdown file.
For example, if you have a folder named
subfolder that contains a
README.md and a
nice-picture.png, showing it in your
README is done by
If you wish to link to images or pages in a different folder, simply specify the path relative to the homepage:
If your markdown document does not start with a level 1 heading, it will be automatically added based on the file name.
Table of Contents Generation
You can use the
madness --toc FILENAME command to generate a
"Table of Contents" markdown file.
Directories that are made only of lowercase letters, underscoes, dash and/or
/^[a-z_\-0-9]+$/) will not be displayed in the navigation. In
other words, directories must have at least one uppercase letter or a space
to be recognized as a documentation directory.
Controlling Sort Order
To control the sort order of the automatically generated navigation elements, simply perfix your files and directories with digits followed by a dot and a space, just like you would create an ordered list in Markdown. The numbers will be omitted when they are displayed.
./ ├── 1. Some file or folder └── 2. Another file or folder
To add basic authentication, use the
--auth user:password command line argument or the equivalent
auth configuration option.
If you wish to avoid storing the basic authentication credentials in the configuration file, you may use ERB tags to load the credentials from environment variables:
auth: <%= ENV['BASIC_AUTH'] %>
There are two ways to change how Madness looks.
Option 1: Change CSS and HTML (Slim)
In order to have complete control over the CSS and generated HTML, you can override the views and styles. Views are provided as Slim templates, and CSS is provided as SCSS.
Madness comes with a command that copies the default theme to a folder of your choice, where you can customize it to your taste. Run:
$ madness create theme my_theme
my_theme is the folder that will be created.
To use the created theme, simply run Madness with the
$ madness --theme my_theme
Option 2: Change CSS only
If you are looking to implement a smaller CSS change, follow these steps:
- Create a directory named
cssin your root documentation directory.
- Copy the main.css file to it.
- Update it as you see fit.
Note that this functionality is not guaranteed to stay as is in future versions of madness.
Forcing HTTPS Connection
To have Madness redirect HTTP traffic to HTTPS, set this environment variable:
$ export MADNESS_FORCE_SSL=1
Madness server is also available as a docker image.
This command will start the server on localhost:3000, with the current directory as the markdown documentation folder
$ docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
You may create an alias for convenience:
$ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness' $ medness --help
For more information about the docker image, see: