Package: anchorhub
AnchorHubAnchorHubis a command-line tool that makes it easy and intuitive to
utilize GitHub’s auto-generated anchor tags in yourMarkdowndocuments,
allowing you to create rich, user-friendly documentation in your GitHub
repos without having to figure out what those auto-generated tags will
be.FeaturesEasily use GitHub’s automatically generated anchor tagsSimple, customizable syntax that just worksWorks with single files, a single directory level, or an entire
directory treeInstallationYou can install AnchorHub usingpip:$ pip install anchorhubIf you’re having trouble with pip, you can also install from source:$ git clone https://github.com/samjabrahams/anchorhub.git
$ cd anchorhub
$ python setup.py installTo-do ListVerify cross-platform compatibility (currently only tested on OSX)Support for ReStructuredTextDefine API for using custom anchor generation orMore tests!Known IssuesShould not change text within in-line code blocks (those marked by `
backticks)Quick Start Guide1. Define your tagsInside your Markdown files, define tags at the end of header lines. By
default, the syntax for this is{#my-tag-here}:# This is a header that I would like to make a tag for {#tag}

You can also use Setext (underlined) style headers {#setext}
------------------------------------------------------------The default is similar toPandoc’s Markdown header
identifiers2. Use the tags as you would regular HTML anchorsElsewhere, you can use the previously defined tags inlinks to provide a
direct path to the header:[This links back to the header using the AnchorHub tag 'tag'](#tag)

[This one links to the Setext header](#setext)3. Run AnchorHub on your Markdown filesanchorhubwill parse your Markdown files. You’ve got a few options
for runninganchorhub: run it on a single file, run it on a single
level of a directory, or run it on an entire directory tree.Single file use:
$ anchorhub mytags.md

Directory use (single level):
$ anchorhub .

Directory use (provided directory level and all subdirectories):
$ anchorhub . -rThis will output your processed files in a new folder in your current
directory, ‘anchorhub-out/’4. Enjoy your (relatively) hassle-free GitHub anchor linksAssuming all of the above Markdown was in a file named ‘mytags.md’, here
is what we’d find inside of ‘anchorhub-out/mytags.md’:# This is a header that I would like to make a tag for

You can also use Setext (underlined) style headers
------------------------------------------------------------
...
[This links back to the header using the AnchorHub tag 'tag'](#this-is-a-header-that-i-would-like-to-make-a-tag-for)

[This one links to the Setext header](#you-can-also-use-setext-underlined-style-headers)LicenseCopyright 2016, Sam Abrahams. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.