Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 1.13 KB

titles.md

File metadata and controls

68 lines (44 loc) · 1.13 KB

Page Titles

All pages included with stitchmd are assigned a title.

By default, the title is the name of the item in the summary. For example, given the following:

<!-- summary.md -->
- [Introduction](intro.md)

<!-- intro.md -->
Welcome to Foo.

The title for intro.md is "Introduction".

Output
- [Introduction](#introduction)

# Introduction

Welcome to Foo.

A file may specify its own title by adding a heading that meets the following rules:

  • it's a level 1 heading
  • it's the first item in the file
  • there are no other level 1 headings in the file

If a file specifies its own title, this does not affect its name in the summary list. This allows the use of short link titles for long headings.

For example, given the following:

<!-- summary.md -->
- [Introduction](intro.md)

<!-- intro.md -->
# Introduction to Foo

Welcome to Foo.

The title for intro.md will be "Introduction to Foo".

Output
- [Introduction](#introduction-to-foo)

# Introduction to Foo

Welcome to Foo.