CONTENTS.md

AnchorHub Table of Contents

Readme | Table of Contents | AnchorHub User Guide | AnchorHub Definitions | FAQ | About AnchorHub

Readme

• AnchorHub
  • Features
  • Installation
  • To-do List
  • Known Issues
• Quick Start Guide
  1. Define your tags
  2. Use the tags as you would regular HTML anchors
  3. Run AnchorHub on your Markdown files
  4. Enjoy your (relatively) hassle-free GitHub anchor links
• Contribution
• License

AnchorHub User Guide

• Defining AnchorHub Tags
• Link Syntax
• AnchorHub's Command Line Interface
  • Usage
  • Input
  • Output
  • Options
    • Help
    • Display version information
    • Parse all subdirectories, recursively
    • Generate verbose output
    • Overwrite input files
    • Specify which file extensions to parse
    • Specify a wrapper syntax
• Examples
  • Single file
  • Multi-file

Terminology/Definitions

• AnchorHub tags
• Auto-generated anchors
• Wrappers

About AnchorHub

• Beginnings
• Goals
  • Make using AnchorHub as simple as possible
  • Minimize "side-grading" the experience of users
  • Let the user make their own syntax decisions if possible
• About the Author

FAQ

• Why use AnchorHub?
• What about ReStructuredText support?
• Can you add support for non-GitHub style header anchors?
• Why load files into memory instead of just reading from stream?

---

Back to top