Skip to content

ptrkstr/MarkdownChildren

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Logo with list

MarkdownChildren

A command line tool wrapper around MarkdownChildrenKit

Example

GIVEN a readme.md file exists

My favourite things are:
<!-- markdown-children:start -->
<!-- markdown-children:end -->
AND it's in this directory Directory of files and folders
WHEN MarkdownChildren is invoked
MarkdownChildren ~/readme.md -n useH1

THEN the readme.md turns into:

My favourite things are:
<!-- markdown-children:start -->
- [Animals](animals.md)
- animals
  - pets
    - [Cats](animals/pets/cats.md)
    - [Dogs](animals/pets/dogs.md)
  - zoo
    - [Tiger](animals/zoo/tiger.md)
- [Clothes](clothes.md)
- clothes
  - summer
    - [Dress](clothes/summer/dress.md)
    - [Hat](clothes/summer/hat.md)
  - winter
    - [Jumper](clothes/winter/jumper.md)
    - [Pants](clothes/winter/pants.md)
<!-- markdown-children:end -->

Installation

Visit releases and download the command line tool or get the latest by doing the following:

  1. Clone the repo
  2. Open MarkdownChildren.xcodeproj
  3. Wait for Swift Package Depedencies to resolve
  4. Build (CMD+B)
  5. Right click Products > MarkdownChildren, select Show in Finder
  6. cd your terminal to this directory

Usage

  • Run ./MarkdownChildren <location of root markdown file>
  • Run ./MarkdownChildren -h for all options

TODO

  • Use github actions to create downloadable releases
  • Research best way to provide version info via -v

About

A command line tool wrapper around MarkdownChildrenKit https://github.com/patrickbdev/MarkdownChildrenKit

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages