Mater is a super-simple, open source, GitHub-based doc system.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
media
src
.gitignore
LICENSE
README.md

README.md

Mater

Mater

Mater is a super-simple, open source, GitHub-based doc system.

Instead of requiring a complex content management system, which typically requires a database, Mater uses Markdown files stored and versioned in GitHub and auto-published in an Azure Web App.

Mater is open source and was originally developed for use as DailyStory's documentation system.

Live Demo

See Mater powering DailyStory's documentation from DailyStory's Docs Repository.

Auto-Publishing Documentation

Mater makes it insanely easy to publish documentation.

Mater is designed to work with Microsoft Azure's GitHub integration. When new documentation files are checked in they are automatically published to your documentation website running Mater.

Documentation is versioned and maintained in GitHub. Plus, documentation can be edited using virtually any document editing application.

Instructions for setting up Azure auto-publishing

Getting Started

Getting started with Mater is simple: download the code, compile, and run.

The only requirement is that Mater expects to find a \articles\index.md file and a \articles\TOC.md file.

Writing Documentation

Within the \articles directory you add markdown files (any file name eding with .md), images, and other resources.

You can create sub-folders with their own index.md. For example, \articles\auto-publish\azure.md is accessible as /auto-publish/azure.

Markdown files can be referenced directly by removing the .md extension. For example, \articles\demos\hello.md is accessible as /demos/hello.

Want to include images? Just copy and paste images into your directories and reference them in your markdown files.

Setting Page Title, Description and More

You can add a Json string to the start of your markdown file to tell Mater the page title, description, and more.

For example, you can set the <title> of you page by including {title:"My Title"}.

Table of Contents

The Table of Contents, shown to the left of the documentation, is editing in the \articles\TOC.md file.

Site Logo, Navigation and Back Button

The logo used for your documentation site along with all of the top-level navigation is configured in the \articles\settings.json file.

Suggest Edits Link

The suggest edits link, shown to the right of all documentation pages, is built dynamically. You'll need to set the base reference to your GitHub docs in settings.json. Mater will do the rest.

Customizing Mater's UI

Mater is built using the Bootstrap framework, but you can easily add your own CSS, favicon, Google tags and more to Mater.

Simply create a \articles\head.html file - you'll find an example provided in the \articles folder. Content in head.html will be automatically included in the <head> section of your pages.

Does Mater Provide Search?

Yes, but to enable search you'll have to configure a few more things as well as create an instance of Azure Search.

Why Mater?

git-r-done.