Skip to content

Latest commit

 

History

History
423 lines (271 loc) · 9.92 KB

README.md

File metadata and controls

423 lines (271 loc) · 9.92 KB
Raw

markedpp

Preprocessor for documents written in markdown

NPM version Build Status

markedpp is a preprocessor for documents written in markdown. The output itself is again markdown.

It supports the following extensions:

  • Generation of a "Table of Contents"
  • Automatic numbering of Headings
  • Include various files into a single output document
  • Sorted collection of References
  • Autonumbering of ordered lists
  • Automatic update of heading identifiers

This project is inspired by markdown-pp. Albeight the markdown syntax of this project here is slightly different, markdown-pp commands can be used as well.

Table of Contents

Extended Markdown Syntax

The extended markdown syntax for the preprocessor borrows from the already existing image tag. All commands start using a ! followed by the command. Options for the specific command are specified in normal brackets.

!<command> (<options>)

toc

!toc [([level=1-6] [minlevel=1-6] [numbered] [omit="...;..."])]

Inserts a "Table of Contents" section:

  • level: [optional] level of headings to show (default is 3)
  • minlevel: [optional] min-level of headings to show (default is 1)
  • numbered: [optional] show numbered
  • omit: [optional] remove headings from ToC. Headings need to be given in " and separated by ;

E.g.

  • One
  • Two

    • Two One

      This includes a "Table of Contents" section. All headings up to level=3 will be linked with their references as a unnumbered bullet list.

level

!toc (level=5)

To change the default level of 3 to a different one specify the option level in brackets.

minlevel

!toc (minlevel=2)

The option minlevel only displays the ToC from minlevel leaving out all headings with a lower level.

E.g. with the above example:

numbered

!toc (numbered)

The option numbered displays the ToC without a bullet list but in a flat numbered fashion

E.g.

1. One
1.1. One One
1.1.1. One One One
2. Two
2.1. Two One

The Preprocessor inserts a html comment tag which allows regenerating the TOC on an already preprocessed document.

E.g.

<!-- !toc (level=1) -->

* [One](#one)
* [Two](#two)

<!-- toc! -->

omit

To omit headings in the ToC define those with omit.

E.g. to remove "Table of Contents" and the branch of "Heading 1":

# Table of Contents

!toc (omit="Table of Contents;Heading 1")

# Heading 1
## Heading 1.1
# Heading 2

will result in:

# Table of Contents

<!-- !toc -->

* [Heading 2](#heading-2)

<!-- toc! -->

# Heading 1

## Heading 1.1

# Heading 2

ref

!ref

This command includes a references section displaying all references using the alternate link syntax
[<name>]: <url> "<title>" given in the document being preprocessed.

Local references which start with a "#" are ignored.

E.g.

!ref

[markdown]: http://daringfireball.net/projects/markdown/syntax
[GFM]: https://help.github.com/articles/github-flavored-markdown "Github-Flavored-Markdown"

renders as:

<!-- !ref -->

* [Github-Flavored-Markdown][GFM]
* [markdown][markdown]

<!-- ref! -->

[markdown]: http://daringfireball.net/projects/markdown/syntax
[GFM]: https://help.github.com/articles/github-flavored-markdown "Github-Flavored-Markdown"

include

!include (filename [lang=...])

This inserts the the file specified with filename at the given position in the document being preprocessed. The preprocessor inserts any type of files.

  • filename: [mandatory] Name of file to include
  • lang: [optional] language of file - if set, then GFM fences are added around include.

To include a file with specifying the language use the option lang.

This then will render using GFM fences.

E.g.

!include (test.js lang=javascript)

renders as

```javascript
/* contents of test.js */
```

Files to insert which cannot be found or recursive inset of the same file leaves the !include command as is.

numberedheadings

!numberedheadings [([level=1-6] [minlevel=1-6] [skip=1..] [start=1..] [omit="...;..."])]

Add numbers on headings

  • level: {Number} [optional] level of Headings to show (default is 3)
  • minlevel: {Number} [optional] min-level of Headings to show (default is 1)
  • skip: {Number} [optional] skip number of Headings on min-level
  • start: {Number} [optional] start numbering of Headings with given number
  • omit: {String} [optional] omit numbering of Headings. Headings need to be given in " and separated by ;

All Headings up to level 3 will get numbered. If used, this command shall be given at the very top of a document.

#### level

With the option level, the Headings level where the numbering shall be applied, can be specified.

E.g.

!numberedheadings (level=2)

will number all Headings of level 1 and 2.

Used together with !toc the numbered Headings with show up numberd in the bullet-list style.

E.g.

!toc (numbered) will display the flat style, still with the numbers.

1. One
1.1. One One

#### minlevel

The option minlevel omits numbering all Headings below minlevel.

 #### skip

The option skip skips numbering for the first Headings on minlevel.

 #### start

The option start starts the numbering with the given number.

 #### omit

The option omit omits numbering all Headings matching.

Specials

Using custom anchors

Custom anchors can be added to headings by putting a <a name="..."/> in a separate line right in front of the heading.

<a name="custom-heading"/>
# Heading with custom id

Instead of using the auto generated id #heading-with-custom-id, #custom-heading will be used as anchor in the ToC.

Changing type of autoId generation

Unfortunately there is no unique format which defines the composition of an auto identifier in markdown. marked uses a different format then github.

On the CLI

markedpp --githubid file.md

Or use in your options

var markedpp = require('markedpp'),
    md = '!toc\n# hello\n## hello & again',
    options = { githubid: true };
    
markedpp(md, options, function(err, result){
    console.log(result);
});

Installation

For use from commandline consider global install

npm install -g markedpp

For your project

npm install markedpp

Usage

var markedpp = require('markedpp'),
    md = '!numberedheadings\n!toc(level=1)\n# hello\n## hello again';
    
markedpp(md, function(err, result){
    console.log(result);
    /* Outputs
    <!-- !numberedheadings -->

    <!-- !toc (level=1) -->

    * [1\. hello](#1-hello)

    <!-- toc! -->

    # 1\. hello

    ## 1.1\. hello again
    */
});

To include files the dirname need to be defined via options, otherwise it is assumed that the file to include is relative to the current working directory:

var markedpp = require('markedpp'),
    md = '!include(hello.md)',
    options = { dirname: __dirname };
    
markedpp(md, options, function(err, result){
    console.log(result);
});

CLI

Standalone

$ (cat<<EOF
!numberedheadings
!toc(level=1)
# hello
## hello again
EOF
) > hello.md
$ markedpp hello.md
<!-- !numberedheadings -->

<!-- !toc (level=1) -->

* [1\. hello](#1-hello)

<!-- toc! -->

# 1\. hello

## 1.1\. hello again

Together with marked

$ markedpp --no-tags hello.md | marked
<ul>
<li><a href="#1-hello">1. hello</a></li>
</ul>
<h1 id="1-hello">1. hello</h1>
<h2 id="1-1-hello-again">1.1. hello again</h2>

Running Tests & Contributing

If you want to submit a pull request, make sure your changes pass the tests. If you're adding a new feature, be sure to add your own test.

To run the tests:

npm test

Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.

License

Copyright (c) 2014, Commenthol. (MIT License)

See LICENSE for more info.

References