markdown-decorator

A lightweight utility for inserting text into markdown files and templates.

Table of contents

• 1. Installation
• 2. Usage
  • 2.1. Pass a markdown string to its constructor
  • 2.2. Insert your product's (semantic) version
  • 2.3. Generate a table of contents
  • 2.4. Method chaining
  • 2.5. Templates
  • 2.6. Insert a string between delimiters
• 3. Version and CHANGELOG
• 4. Contributing
• 5. License

1. Installation

$ npm install --save markdown-decorator

2. Usage

2.1. Pass a markdown string to its constructor

const MarkdownDecorator = require('markdown-decorator')
const fs = require('fs')
const pkg = require('./package')
 
const decorator = new MarkdownDecorator(fs.readFileSync('README.md'))
 

2.2. Insert your product's (semantic) version

## Version and CHANGELOG
 
`markdown-decorator`'s latest version is
<!-- semver -->
<!-- semverend -->.
Please read the [CHANGELOG][changelog-url] for details.

// pkg.version === '1.1.0-alpha.1'
decorator.semver(pkg.version)

Inserts the semver:

## Version and CHANGELOG
 
`markdown-decorator`'s latest version is
<!-- semver -->1.1.0-alpha.1<!-- semverend -->.
Please read the [CHANGELOG][changelog-url] for details.

2.3. Generate a table of contents

Use toc comment tags as delimiters:

## Table of contents
<!-- toc -->
<!-- tocend -->

decorator.toc(markdown)

2.4. Method chaining

const md = decorator
  .semver(pkg.version)
  .toc(markdown)
  .toString()

2.5. Templates

<%= header %>
<%= body %>
---
<%= footer %>

Use the decorate method with an object literal to insert values in your template:

const md = decorator.decorate({
  version: '1.0.0'
})
.toString({
  template,
  header: '# TEMPLATE HEADER',
  body: decorator.markdown,
  footer: 'TEMPLATE FOOTER'
})

2.6. Insert a string between delimiters

# `<!-- title --><!-- titleend -->`

decorator.insert('markdown-decorator', {
    open: 'title',
    close: 'titleend'
})
decorator.markdown
// => # `<!-- title -->markdown-decorator<!-- titleend -->`

3. Version and CHANGELOG

markdown-decorator is at v1.0.0. Please see the CHANGELOG for details.

4. Contributing

We welcome contributors and pull requests. Check out the guidelines for

• Contributing to generator-apiproxy and our
• Contributor Covenant Code of Conduct.

Contributions are stories with a beginning, a middle, and an end, all told through issues, comments, commit logs, and pull requests.

• Peruse open issues or
• Open a new pull request (PR)

5. License

© Greg Swindle

---