# 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)) ``` $ gem install mdtoc ``` ## Usage ``` $ 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. ``` $ 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"). ``` $ 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 ``` task default: %w[mdtoc] desc 'Update Markdown table of contents and push changes to the git repository' task :mdtoc do |t| command = <<~END set -e git pull 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 -m 'Update TOC' git push END %x|#{command}| end ``` See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example. ## Development ### Installation Requirements: * [Bundler](https://bundler.io/) ``` # Install dependencies $ bundle ``` ### Usage ``` # List rake tasks $ rake -T rake build # Build mdtoc-0.0.2.gem into the pkg directory rake default # Run the build, rubocop:auto_correct, sorbet and test tasks rake install # Build and install mdtoc-0.0.2.gem into system gems rake install:local # Build and install mdtoc-0.0.2.gem into system gems without... rake release[remote] # Create tag v0.0.2 and build and push mdtoc-0.0.2.gem to ru... rake rubocop # Run RuboCop rake rubocop:auto_correct # Auto-correct RuboCop offenses 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} ```

A tiny and experimental mutation testing framework for exploring research ideas.

For those times you realize you should have namespaced your class(es) or module(s).

A Ruby code uglifier

Outil is a library for storing and importing reusable code

A Ruby page class generator (for use with the page-object gem)

Automatically renew your parking ticket when it expires.

Improved puts debugging output for busy Ruby programmers.

A regular syntax matcher facilitating DSL's construction

Ruby code rewriter. Currently just a proof of concept.

Configurations for Rubocop and other style enforcers/linters

Data-driven testing framework.

This is a plugin for the RuboCop code style checker. It checks for YaST specific issues.

The Siyousho gem is designed to facilitate End-to-End (E2E) testing by automatically generating detailed specification documents. These documents are enriched with screenshots, providing a visual context for each testing step. Ideal for developers and QA teams who require comprehensive test reports, this gem helps in capturing the state of the application at various stages of the testing cycle.

You can add a step hook like a turnip for system test

Use TableSyntax to create and parse data tables directly in Ruby code. Extracted from tomykaira's [RSpec::Parameterized](https://rubygems.org/gems/rspec-parameterized).

sanitize tweet

Tweezer is a CLI to add, remove, and edit Gemfile dependencies in an automated way

Twitter api awesome handling with retry

Umwelt is a domain architecture development(knowledge management) tool, for handy prototyping domain specification with code structure.