Giter Club home page Giter Club logo

markdownlazylinks's Introduction

Markdown Lazy Links

This program modifies markdown files to:

  • add table of contents to the head of your file (and ignoring Hugo's frontmatter if it exists)
  • generate a footer with all (non-image) links from your file
  • modify existing titles to titlecase format

The changes are put into a file called "processed" in the same directory, so the original files should be untouched. Vitally, you should backup your files to another directory first if you are unsure or modifying important files with this program.

Images

Before and after conversion:

Preview web

The process of manual review (can disable)

Preview terminal

Download

Get the MDLL.zip:

v1.0.0 Released Here

How to use

  1. Place .exe in the same directory as markdown files (optional but easier)
  2. In terminal run the .exe
  3. Follow prompts

Options

options:
  -h, --help        show this help message and exit
  --path [PATH]     Path to a markdown file or a directory to process.
  --no-links        Do not parse and reformat links as footnotes.
  --no-titlecase    Do not convert headings to title case.
  --no-interactive  Disable interactive mode for title case corrections.
  --no-toc          Do not generate a Table of Contents at the beginning of the document.

markdownlazylinks's People

Contributors

danieljudd avatar

Stargazers

 avatar

Watchers

 avatar

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.