Skip to content

Commit

Permalink
feat(toc): use markdown-toc directly to update inline
Browse files Browse the repository at this point in the history
* https://github.com/jonschlinkert/markdown-toc
  - Generate a markdown TOC (table of contents) for any markdown files.
  • Loading branch information
myii committed Feb 23, 2019
1 parent 0dc0dc4 commit a5bae1e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ jobs:
- go get github.com/myii/maintainer
- maintainer contributor

# Update Tables of Content in the relevant `.md` files
- npm install markdown-toc -D
- markdown-toc -i CONTRIBUTING.md
# - markdown-toc -i README.md
- markdown-toc -i TOFS_pattern.md

# Install all dependencies required for `semantic-release`
- npm install @semantic-release/changelog@3 -D
- npm install @semantic-release/exec@3 -D
Expand Down
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# How to contribute

<table><tr><th>Table of Contents</th></tr><tr><td>
<!-- toc -->
<!-- tocstop -->
</td></tr></table>

## Commit message formatting

### Automation of multiple processes
Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ template-formula
A SaltStack formula that is empty. It has dummy content to help with a quick
start on a new formula and it serves as a style guide.

.. contents:: **Table of Contents**

**NOTE**

See the full `Salt Formulas installation and usage instructions
Expand Down
5 changes: 5 additions & 0 deletions TOFS_pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ Modified by Daniel Dehennin <daniel.dehennin@baby-gnu.org>

All that follows is a proposal based on my experience with [Saltstack](http://www.saltstack.com/). The good thing of a piece of software like this is that you can "bend it" to suit your needs in many possible ways, and this is one of them. All the recommendations and thoughts are given "as it is" with no warranty of any type.

<table><tr><th>Table of Contents</th></tr><tr><td>
<!-- toc -->
<!-- tocstop -->
</td></tr></table>


## Usage of values in pillar vs templates in file_roots

Expand Down

0 comments on commit a5bae1e

Please sign in to comment.