Skip to content

Latest commit

 

History

History
189 lines (116 loc) · 4.63 KB

use_case.md

File metadata and controls

189 lines (116 loc) · 4.63 KB
Raw

Include Page TOC

Use file inclusion to include a page table of contents (page TOC).

The page TOC is a tree of links:

  • Each link goes to a corresponding markdown title.
  • The tree structure reflects the relative depths of the linked headers.

Below are files to be included and an includer file that will generate the page TOC.

Note that all file inclusion (even nested inclusions) will be performed before the page TOC is built, so the page TOC covers all the included material.

Files to Be Included

Here's a file containing markdown to be included:

markdown_0.md:

        
## Includee 0 level-two title.

### Includee 0 level-three title.

### Another includee 0 level-three title.

## Another includee 0 level-two title.

Here's another:

markdown_1.md:

        
## Includee 1 level-two title.

### Includee 1 level-three title.

### Another includee 1 level-three title.

## Another includee 1 level-two title.

Includer File

Here's a template file that includes them:

includer.md:

# Page Title

@[:page_toc](## Page Contents)

## Includer level-two title.

### Includer level-three title.

### Another includer level-three title.

## Another includer level-two title.

@[:markdown](markdown_0.md)

@[:markdown](markdown_1.md)

The treatment token :page_toc specifies where the page TOC is to be inserted.

Include Via markdown_helper

CLI 
markdown_helper include --pristine includer.md included.md

(Option --pristine suppresses comment insertion.)

API

include.rb:

require 'markdown_helper'

# Option :pristine suppresses comment insertion.
markdown_helper = MarkdownHelper.new(:pristine => true)
markdown_helper.include('includer.md', 'included.md')

File with Inclusion

Here's the finished file with the inclusion:

included.md:

# Page Title

## Page Contents
- [Includer level-two title.](#includer-level-two-title)
  - [Includer level-three title.](#includer-level-three-title)
  - [Another includer level-three title.](#another-includer-level-three-title)
- [Another includer level-two title.](#another-includer-level-two-title)
- [Includee 0 level-two title.](#includee-0-level-two-title)
  - [Includee 0 level-three title.](#includee-0-level-three-title)
  - [Another includee 0 level-three title.](#another-includee-0-level-three-title)
- [Another includee 0 level-two title.](#another-includee-0-level-two-title)
- [Includee 1 level-two title.](#includee-1-level-two-title)
  - [Includee 1 level-three title.](#includee-1-level-three-title)
  - [Another includee 1 level-three title.](#another-includee-1-level-three-title)
- [Another includee 1 level-two title.](#another-includee-1-level-two-title)

## Includer level-two title.

### Includer level-three title.

### Another includer level-three title.

## Another includer level-two title.

        
## Includee 0 level-two title.

### Includee 0 level-three title.

### Another includee 0 level-three title.

## Another includee 0 level-two title.

        
## Includee 1 level-two title.

### Includee 1 level-three title.

### Another includee 1 level-three title.

## Another includee 1 level-two title.

And here's the finished markdown, as rendered on this page:

Page Title

Page Contents

Includer level-two title.

Includer level-three title.

Another includer level-three title.

Another includer level-two title.

Includee 0 level-two title.

Includee 0 level-three title.

Another includee 0 level-three title.

Another includee 0 level-two title.

Includee 1 level-two title.

Includee 1 level-three title.

Another includee 1 level-three title.

Another includee 1 level-two title.