html_toc

README

Go HTML TOC

DISCLAIMER: This script doesn't handle correctly headings that contains other tags. It is made to work only on plain headings that's created by a rich text or markdown editor.

Extracts relevant table of contents data out of your HTML markup and add permalinks to your markup's headings.

Takes your HTML markup, outputs a string in JSON format of the relevant data (level, content and slug) and inserts permalinks to the markup's headings.

Found bugs?

Please contact me at at@aranggitoar.com.

Documentation

Index

• func CreateSamePageSlug(s string) string
• func CreateTOC(s string) (string, string)
• func InsertAnchorTag(s string) string
• func RemoveAnchorTag(s string) string

Functions

func CreateSamePageSlug

func CreateSamePageSlug(s string) string

CreateSamePageSlug creates slug out of a title.

func CreateTOC

func CreateTOC(s string) (string, string)

TODO: Separate the anchor tag (for permalink) insertion logic. CreateTOC creates a table of contents out of the markup and a markup with permalink on the headings. Returns the table of contents in a JSON format and the edited markup.

func InsertAnchorTag

func InsertAnchorTag(s string) string

InsertAnchorTag inserts anchor tags inside a heading.

func RemoveAnchorTag

func RemoveAnchorTag(s string) string

RemoveAnchorTag removes anchor tags inside a heading.