Giter VIP home page Giter VIP logo

ngithubtoc's Introduction

nGitHubTOC

a simple web page to quickly create table of content markdown for GitHub markdown files

Overview

I could never find an easy to use, online table-of-content maker for GitHub markdown files. There were many solutions that required downloading or installing something on my computer. For such a trivial task I felt that was unnecessary.

This page just uses JavaScript to extract headings from a markdown file and return table-of-content markdown.

The Magic

https://imthenachoman.github.io/nGitHubTOC/

ngithubtoc's People

Contributors

imthenachoman avatar orion486 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

ngithubtoc's Issues

specify a license

I appreciate your toc generator. As simple as I looked for. I made some small changes fitting my needs. Now I ask if I can publish my changes as you didn't specify a license. I prefer MIT but of course do what is your preference.

Regards, Simpel

Recognizes a comment in code tags as a header

Bug description

The markdown

# foo
```
# bar
```

will yield to the following TOC:

- [foo](#foo)
- [bar](#bar)

Expected behaviour:

Ignore # inside code tags. The above markdown should yield to the ToC

- [foo](#foo)

Underscores '_' removed, resulting in invalid links

When converting my autocue README.md, I realized that underscores _ are removed, resulting in invalid links.

For example, the heading

### Install `cue_file`

gets converted to

  - [Install `cue_file`](#install-cuefile)

instead of

  - [Install `cue_file`](#install-cue_file)

Thanks for a very usable little tool!

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.