marko-backlinks 0.3.0

Awesome `marko-backlinks` is a Python cli/package created with https://github.com/TezRomacH/python-package-template

marko-backlinks

🤔 Description

This project provide a markdown to markdown converter that adds a Bi-Directional Link Section at the end of each markdown files that is converted.

The project also provide a pre-commit hook so you can easily integrate it within your own projects easily

It relies heavily on the Marko python package that is the only Markdown Parser with a Markdown Renderer that I know of.

💭 Why

I believe a great amount of information can be extracted from collaborative notes if we take time to structure them correctly.

I wanted:

• To make collaborative notes
• To organize the notes in a Roam like manner
• Everyone to be able to navigate through the notes without installing anything
• This system to be easily adopted by a software engineering team.

Using git and this converter as a pre-commit, I can easily do all of this ! 🚀

🏃 Getting Started

Installation as a python package with pip

Considering you already have python available. You can simply add th

pip install --user marko-backlinks

or install with Poetry

Then you can see all the option of the CLI using

marko-backlinks --help

Installation as a pre-commit hook

This pre-commit hook use the [pre-commit](https://pre-commit.com) tool that you will need to install.

Add the following line to your pre-commit configuration (.pre-commit-config.yaml) at the root of your repository.

repos:
-   repo: https://github.com/jb-delafosse/marko-backlinks
    rev: v0.2.3
    hooks:
      - id: marko-backlinks
        args: ['directory-containing-my-markdown']

and install the hook using pre-commit install

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{marko-backlinks,
  author = {jb-delafosse},
  title = {Awesome `marko-backlinks` is a Python cli/package created with https://github.com/TezRomacH/python-package-template},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/jb-delafosse/marko-backlinks}}
}

Credits

This project was generated with python-package-template.