Skip to content

v1.2.0 - Documentation & Tooling

Choose a tag to compare

@GaryDean GaryDean released this 31 Dec 01:04
· 9 commits to main since this release

What's New

Manpage

Full Unix manpage with all commands, options, and examples.

sudo cp mdheaders.1 /usr/share/man/man1/
man mdheaders

Bash Completion

Tab completion for commands, options, and markdown files.

sudo cp mdheaders.bash_completion /etc/bash_completion.d/mdheaders

Improved Documentation

  • Standardized function docstrings
  • Enhanced help text with Behavior section
  • Header comment with license and URL

Installation

# Quick install
sudo curl -fsSL https://raw.githubusercontent.com/Open-Technology-Foundation/mdheaders/main/mdheaders -o /usr/local/bin/mdheaders && sudo chmod +x /usr/local/bin/mdheaders

# Full install (from source)
git clone https://github.com/Open-Technology-Foundation/mdheaders.git
cd mdheaders
sudo cp mdheaders /usr/local/bin/
sudo cp mdheaders.1 /usr/share/man/man1/
sudo cp mdheaders.bash_completion /etc/bash_completion.d/mdheaders

Testing

  • 26/26 tests passing
  • ShellCheck: 0 warnings