Generate a markdown TOC (table of contents) with Remarkable.
react markdown toc
Generate a markdown TOC (table of contents) with Remarkable.
Generate a markdown TOC (table of contents) with Remarkable.
<!-- vscode-markdown-toc -->
Ensure that your Markdown TOC is correct
Generate a markdown TOC (table of contents).
Markdown TOC extraction and section management for CrewX
Gulp plugin for markdown-toc. Generate a markdown table of contents for one or more markdown files, and an optional index for multiple files.
Generate a markdown TOC (table of contents) with Remarkable.
Infomaker JS module: markdown-toc-parser
Generates a markdown TOC (table of contents)
Generating and updating table of contents in Markdown files which conform with prettier.
Insert a markdown TOC(Table Of Content) before posts be rendered.
Generates a markdown TOC (table of contents)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --> **Table of Contents**
<!-- vscode-markdown-toc --> <!-- prettier-ignore --> - [Matsuri Hooks](#matsuri-hooks) - [Motivation](#motivation) - [Usage](#usage) - [Installation](#installation) - [Examples](#examples) - [useFetch](#usefetch) - [Conditional fetch]
<!-- vscode-markdown-toc -->
[markdown-toc](https://github.com/jonschlinkert/markdown-toc) recursively usable on a folder.
## Installation ```sh npm i -S markdown-toc-x ```
Combined documentation automation: update-markdown-toc + nx-graph-to-mermaid
Generate a markdown TOC (table of contents) with Remarkable.
Generate a markdown TOC (table of contents).
Generate a markdown TOC (table of contents) with Remarkable.
Markdown Table of Contents generator
Easy-to-Use Heterogenous SQL Database
A mdbook preprocessor which adds extra js and css file for ToC hydration.
This library provides a variety of path finding and graph operations. Work in progress.
This library provides a variety of path finding and graph operations. Work in progress.
A danger.systems plugin for your markdown TOC.
Class to help with GitHub markdown: * File inclusion * Page TOC
Mountable Rails engine that renders markdown files as a browsable documentation site with syntax highlighting, TOC generation, category grouping, and mode-based content filtering.
# mdtoc - Markdown Table of Contents Read Markdown files and output a table of contents. ## Installation Requirements: * [Ruby](https://www.ruby-lang.org/en/) (see [.ruby-version](./.ruby-version)) ```bash gem install mdtoc ``` ## Usage ```bash mdtoc --help Usage: mdtoc [options] files or directories... -h, --help Show this message -o, --output PATH Update a table of contents in the file at PATH -a, --[no-]append Append to the --output file if a <!-- mdtoc --> tag isn't found -c, --[no-]create Create the --output file if it does not exist ``` 1. Add a `<!-- mdtoc -->` tag to a Markdown file. ```bash echo '<!-- mdtoc -->' >> README.md ``` 2. Run `mdtoc` and specify input files or directories (eg. the "test/samples" directory) and an output file (eg. "README.md"). ```bash mdtoc -aco README.md test/samples ``` ## Example Rakefile Create a `Rakefile` with the contents below, then run [`rake`](https://github.com/ruby/rake) to: * `git pull` * `git add` any `*.md` files * Run `mdtoc` to update the generated table of contents in the ./README.md file * Git commit and push any changes ```ruby task default: %w[mdtoc] desc 'Update Markdown table of contents and push changes to the git repository' task :mdtoc do command = <<~CMD set -e if [ -n "$(git diff --name-only --diff-filter=U)" ]; then echo 'Error: conflicts exist' >&2 exit 1 fi mdtoc --append --create --output README.md docs/ git add *.md **/*.md git commit -qm 'Update TOC' || true git pull git push CMD sh command, verbose: false do |ok, status| unless ok fail "Failed with status: #{status.exitstatus}" end end end ``` See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example. ## Development ### Setup Requirements: * [Bundler](https://bundler.io/) * [chruby](https://github.com/postmodern/chruby) (recommended) ```bash # Setup development environment bin/setup ``` ### Tasks ```bash # List rake tasks rake -T rake build # Build gem into the pkg directory rake default # Run the build, rubocop, sorbet and test tasks rake install # Build and install gem into system gems rake rubocop # Run RuboCop rake sorbet # Run the Sorbet type checker rake test # Run tests # Run mdtoc with test inputs ruby -Ilib bin/mdtoc test/samples # Run mdtoc with test inputs, and write to a newly created output file f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f} ``` ### Publishing 1. Bump version in `lib/mdtoc/version.rb` 2. Run `bundle install` to update `Gemfile.lock` 3. Commit the changes 4. Run `rake release` to publish the gem to RubyGems, create the git tag, and push
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.
No description provided.