Please note that the list is by no means authoritative or exhaustive and is not a list of recommendations, since we can only endorse MarkdownTOC our contribution to the Markdown Table of Content generators toolbox. Here follows a list of other Markdown Table of Contents generators, for inspiration and perhaps even use in the situation where the MarkdownTOC Sublime Text plugin is not the right tool for the job. Daring Fireballs Markdown Syntax Specification.MarkdownTOC is licensed under the MIT License.ApplicationĬontributions are most welcome, please see the guidelines on contributing. Here is listed what Markdown rendering platforms and tools where compatibility and incompatibily has been asserted with the MarkdownTOC plugin. This is by no means an exhaustive list and you are welcome to provide additional information and feedback. id_replacements, (see: Manipulation of auto link ids)Ī configuration for writing Markdown primaily for use on Github could look like the following:.defaults.markdown_preview, (see: Markdown Preview compatible).defaults.uri_encoding, (see: URI encoding).defaults.style, (see: Ordered or unordered style for TOC elements).defaults.remove_image, (see: Preserve images in headings).defaults.lowercase, (see: Lowercasing in ids).defaults.bullets, (see: Customizable list bullets in TOC).defaults.levels, (see: Control of levels listed in TOC).defaults.link_prefix, (see: Link Prefix).defaults.indent, (see: Specify custom indentation prefix).defaults.bracket, (see: Auto linking for clickable TOC).toanchor, (see: Auto anchoring when heading has anchor defined).tolink, (see: Auto linking for clickable TOC).MarkdownTOC Settings - default (see: Attributes)įor an overview of the specific behaviour behind an attribute, please refer to the below list.MarkdownTOC Settings - user (this section).Attributes specified in MarkdownTOC begin tag (see: Customizing generation of TOC using attributes).Please see the section on attributes for an overview of values and the section on customization. See the Quick Start to get going or the Usage section for details on how to utilize customization and configuration.įor the following sample Markdown document: When you have completed the installation of the plugin, you can insert an automatically generated TOC based on your Markdown headings. Insertion of TOC based on headings in Markdown document The MarkdownTOC plugin is rich on features and customization, useful for both work on a single Markdown document or if you have several Markdown documents that require special TOC generation. Now you can go on and edit your document further or you can customize you TOC, please read on. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |