Light

magnetikonline / markdown-toc-generate Goto Github PK

View Code? Open in Web Editor NEW

24.0 3.0 7.0 26 KB

Table of contents (TOC) generator for a given Markdown page source.

Home Page: https://magnetikonline.github.io/markdown-toc-generate/

License: MIT License

CSS 5.35% JavaScript 80.52% HTML 14.13%

webtool markdown

markdown-toc-generate's Introduction

Markdown TOC generate

Client side Markdown table of contents (TOC) generator.

Usage

Paste source Markdown document into first textarea.
Select options.
Hit Generate.
Final table of contents dropped into second textarea.
Hit Copy to clipboard and you're done.

Tests

Tests for stripPunctuation(), a JavaScript implementation of CommonMark's int cmark_utf8proc_is_punctuation(int32_t uc) function under test/.

Implementation of stripPunctuation() ensures generated links to headings are valid when dealing with characters/languages using extended UTF-8 character sets.

Online

Available here: https://magnetikonline.github.io/markdown-toc-generate/.

Built and tested against Google Chrome (version 75).

Reference

markdown-toc-generate's People

Contributors

Stargazers

Watchers

Forkers

shikherverma croogie ftw-soft jdblab poblabs terry97 lonsty

markdown-toc-generate's Issues

not working

hi, I tried your toc generate online, I have a bug report, it's not working, some of ## title missing(say 查看运行的容器列表) and the link is not right, please check.
my markdown is as below:
https://github.com/huahuayu/yum-docker-cookbook/blob/master/README.md

Bug in headlines with backticks

Thanks for this lovely project! It's been easy to use!

I used a headline called

#### `active` vs `focused`

And the content item generated for it resulted in

active` vs `focused

instead of

`active` vs `focused`

which broke the formatting.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.