Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 4.06 KB

README-en_US.md

File metadata and controls

87 lines (54 loc) · 4.06 KB

Markdown title renumbering

Interaction-WebUI Version MIT

Cover

1. Project background

When writing Markdown on a daily basis, we may encounter such a situation:

  • Document migration and integration: when migrating or integrating documents, the original title number may be confused
  • Document reconstruction: When reconstructing a document, for example, only one title is modified, but the numbers of all subsequent titles are changed.

These situations are time-consuming, labor-intensive, and error-prone to handle. Therefore, we urgently need a tool to help us solve these problems.

While searching the internet for solutions, I only found basic script code that was not very feature-rich and user-friendly. So I decided to develop a full-featured tool myself to solve these problems.

2. Project Features

  • One-click processing: You only need to import the Markdown document to be numbered, and all operations can be completed
  • The whole process of number removal and generation: the original title number can be removed and then re-numbered
  • Operation-friendly: Web-based GUI interface, no need to execute code
  • Highly customizable: Native serial number removal rules are implemented by regular expression lists, and number generation rules can be highly customized by users.
  • Safe and reliable: the project is open source and documents can be processed offline. Configuration files are stored locally and are not uploaded to the server. No user information will be collected

3. Use

3.1 Third-party hosting page

You can use this project by visiting the following link:

3.2 Download to local

You can also download it from GitHub Releases or Gitee Releases Download this project locally and open the index.html file in the compressed package to use it.

4. Project screenshots

In the main interface, after selecting to import a Markdown file, the original document will be displayed on the left and the processed document will be displayed on the right.

Main interface

In the configuration interface, simply select, visually preview, and easily complete customization operations!

Configuration interface

Rich help documentation makes it easy for you to get started!

Help Document

4. Friendly links

This project uses the following open source projects:

Font:

5. Open source agreement

This project follows the MIT open source license.

CopyRight © 2023 Jiang Liu