Markdown tag for document title
I write books and research papers in Markdown that I post exclusively on GitHub and HTML title tags in Markdown don't work on GitHub so I use the convention that:
Document Title
==============
***This is a subtitle***
**Author:** *Me*
# Chapter One: Overview
Do you know the way?
---
# Chapter Two: Foo
Foo is the way...
---
Which ends up looking like:
Document Title
This is a subtitle
Author: Me
Chapter One : Overview
Do you know the way?
Chapter Two : Foo
Foo is the way...
I use the ---
in order to separate chapters because it looks good and helps to find the chapter in the text. This does present a problem however when the Markdown document becomes large in which case the Markdown Preview Window then begins to freeze up on you every time you type as it refreshes or Grammarly starts to bug out and take a REALLY long time. This is the justification for using the ===
H1 Title Format because when the document gets large you need to break it up, in which case it's nice to use the format:
Document Title
==============
***This is a subtitle***
**Author:** *Me*
[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >>](URL)
---
# Chapter Two: Foo
Foo is the way...
---
[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >> ](URL)
Which then looks like:
Document Title
This is a subtitle
Author: Me
<< Previous Chapter | Content Table | Next Chapter >>
Chapter Two : Foo
Foo is the way...
<< Previous Chapter | Content Table | Next Chapter >>
I have also given up on using the Wiki filename for the Title because it does not allow for hyphenated words, which messes up my chapter titles, so I've switched to all lowercase filenames starting with the chapter index 01_chapter_name.md
, 02_chapter_name-with-hyphens.md
, ... with the ===
H1 Title Format and moved my Markdown books into the main repository so I can use Issue Driven Development and GitHub Issues and Projects with one Project per chapter so I can remember all of the things to do and get through the backlog.
If you are referring to pandoc markdown specifically the simplest approach is to use '%', e.g.
% Document Title
# Header 1
content
## Header 2
## Header 2
see http://pandoc.org/README.html#metadata-blocks for more information on pandoc markdown.