Skip to content

Benjscho/md2norg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md2norg: a Markdown to Neorg Converter

This Rust script converts Markdown files to Neorg (.norg) format. It provides options for recursive directory processing, output to a new directory, and replacing original files.

It's been really quickly hacked together and not tested that much so don't trust it. Please let me know if you find any bugs with a minimal repro in issues.

Features

  • Convert Markdown headings, code blocks, lists, and todos to Neorg format
  • Output to a new directory
  • Process dirs recursively

Installation

Option 1: Install from GitHub

  1. Make sure you have Rust installed on your system. If not, you can install it from https://www.rust-lang.org/.

  2. Install the converter directly from GitHub using cargo:

cargo install --git https://github.com/benjscho/md2norg.git
  1. The binary will be installed in your Cargo bin directory. Make sure this directory is in your PATH.

  2. You can now run the converter using:

md2norg [OPTIONS]

Option 2: Clone and Build

  1. Make sure you have Rust installed on your system. If not, you can install it from https://www.rust-lang.org/.

  2. Clone this repository:

git clone https://github.com/benjscho/md2norg.git
cd md2norg
  1. Install the cli:
cargo install --path ./

Uninstallation

To uninstall the converter, run:

cargo uninstall md2norg

Usage

Run the converter using the following command:

md2norg --help

Examples

  1. Convert files to a new directory:
md2norg --input /path/to/markdown/files --output /path/to/output/directory
  1. Convert files recursively:
md2norg --input /path/to/markdown/files --output /path/to/output/directory --recursive

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

About

markdown to neorg quick converter

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages