3kh0 / readme-toc

πŸ“œ Generate a Table of Contents from GitHub Markdown or Wiki online.

Home Page:https://toc.3kh0.net

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub TOC generator

This web page allows users to generate a Table of Contents from GitHub Markdown or Wiki online. Simply paste your Markdown into the left textarea, and the generated Table of Contents will appear in the right textarea. You can then copy and paste the Table of Contents into your GitHub repository or other documentation.

Table of contents generated with readme-toc

To use this tool, you must have JavaScript enabled in your browser.

You can use this now by going to toc.3kh0.net

Why use it

This tool was adapted from markdown-toc put with a few improvements like auto-conversion and better CSS.

Usage

  1. Go to toc.3kh0.net.
  2. Paste your Markdown into the left textarea.
  3. Click the "Convert" button to generate the Table of Contents.
  4. Copy the generated Table of Contents from the right textarea and use it in your documentation.

Contributing

Contributions are welcome! Make sure you follow the Code of conduct before getting started. To contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your changes and commit them with a descriptive commit message.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the original repository.

Please make sure your code follows the project's coding standards and is well-documented. Also, be sure to test your changes thoroughly before submitting a pull request.

If you find a bug or have a feature request, please submit an issue on this GitHub repository.

By contributing to this project, you agree to release your contributions under the terms of the MIT License.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

πŸ“œ Generate a Table of Contents from GitHub Markdown or Wiki online.

https://toc.3kh0.net

License:MIT License


Languages

Language:JavaScript 99.7%Language:HTML 0.3%