Search code examples
documentationmarkdown

Paginating a long Markdown document?

I am writing a handbook for hotplate. It's going to be a lot bigger than I expected. So, I wanted to "break up" the document into several sub-documents.

I am thinking about slicing the documents according to its #titles. So:

# Main title

Under main title

## Installation
Under installation

## Initial use
Under initial use

Would generate three files:

  • maintitle.html -- with a point list pointing to installation.html and initialuse.html ("next")
  • installation.html -- with a link to maintitle.html ("prev") and one to initialuse.html ("next)
  • initialuse.html -- with links to installation.html ("prev")

It basically breaks up a Markdown file into sections.

Does something like this already exist?

Solution

  • "no" (3 years later) I guess this will help people in the future with the same question!