Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 1.67 KB

README.md

File metadata and controls

63 lines (49 loc) · 1.67 KB

Makurust

Makurust is a powerful tool written in Rust that allows you to effortlessly convert your Markdown files into static HTML pages. Inspired by Typescript based Makudaun tool that was originially written by Yuri Katsuki. Makurust is designed to make the conversion process as fast and efficient as possible.

Usage

To use Makurust, simply run the following command:

chmod a+x ./makurust
./makurust filename.md

As a result, an HTML page will be created from the given Markdown file. If the output file already exists, it will be overwritten.

Makurust was build using third party library - pulldown-cmark = "0.9.2"

Building from source

  1. Clone the Makurust repository using Git:
git clone https://github.com/saidofficial/makurust
  1. Navigate to the Makurust directory
cd makurust
  1. Use Cargo to compile the program with optional '--release' flag
cargo build --release
  1. Run using Cargo run or immediately use binary
  • Cargo run
cargo run
  • Using binary after build
cd target/release/
./makurust

What is working

  • Basic Markdown Support
  • GitHub-like Markdown Style
  • Aligning
  • Images
  • Code snippets

Under development

  • Text style syntax (Italic, Underlined, Stroke Through)
  • Table
  • Syntax highlighting for snippets
  • Checkboxes

TODO: Implement Table support, Darkmode (-dark argument), Implement panics, OS System Err and etc.