AutoMarkdownContents

Automatically generate a Contents section in your readme

Contents

• Example use
• How to use
  • Params
    • Auto
    • Skip First
    • Exclude
  • Use outside of actions
    • Installation
    • Run

Proudly auto-generated!

Example use

steps:
  - uses: actions/checkout@v3
  - uses: thatrandomperson5/AutoMarkdownContents@v1.1.1
    with:
      file: README.md
      auto: true

How to use

It will automatically generate an contents.md with a nested list as the table of contents. Each list item is properly linked up to the right url. Example below for test.md

- [Et orantem](#et-orantem)
    * [Variarum cinnamaque huic accedere laudat Mygdoniusque margine](#variarum-cinnamaque-huic-accedere-laudat-mygdoniusque-margine)
    * [Tenent Phrygum animam ignorat humo versato](#tenent-phrygum-animam-ignorat-humo-versato)
    * [Speciem saxa mutatus portas Gangetica titulum cuncti](#speciem-saxa-mutatus-portas-gangetica-titulum-cuncti)
- [Bello ero ferit](#bello-ero-ferit)
    * [Virgineis neque collecti](#virgineis-neque-collecti)
    * [In igneus tenuantur super](#in-igneus-tenuantur-super)
    * [Nocte et confiteor equos](#nocte-et-confiteor-equos)
    * [Bello fortis convellere liventia](#bello-fortis-convellere-liventia)

Params

Here is some info about the params you can pass using the with: yaml syntax

Name	cli param	description
Auto	-a	Automatically fill in the contents section
Exclude	-e	Exclude this header from the markdown, may mess up indentation
Skip first	--skip-first	Toggle off the skipping of the fist header

Auto

The auto paramater can be passed with auto: true. This parameter is equivalent to -a when using the cli tool. It automatically puts the contents in-between these two comments:

<!-- AutoContentStart -->
<!-- AutoContentEnd -->

Everything in the middle will be replaced by the contents.

Skip First

Can be passed with skip-first: true. Toggles off the defualt skip first param that is used to the first header which is usually the title.

Exclude

Can be passed using this format:

exclude: |
  exclude-this
  exculde-this2

The values must be the slug or the url hash of the header that you wan't to be ignored from the table of contents.

Use outside of actions

You can also use this outside of actions, the table in params can give you the cli flags for the params.

Installation

1. Install python
2. run the command below

pip install git+https://github.com/thatrandomperson5/AutoMarkdownContents

Run

run the python -m ContentsGen [args].

The help command is python -m ContentsGen -h. The output is below

usage: ContentsGen [-h] [-a] [-e EXCLUDE] [--skip-first] file

Makes a table of contents for markdown

positional arguments:
  file

optional arguments:
  -h, --help            show this help message and exit
  -a, --auto
  -e EXCLUDE, --exclude EXCLUDE
  --skip-first