Giter Site home page Giter Site logo

dlblv / makurust Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fromgodd/makurust

0.0 0.0 0.0 53 KB

Markdown to HTML converter written in Rust. Inspired by Katsuki Yuri's Makudaun Tool.

Home Page: https://github.com/saidofficial/makurust

License: MIT License

Rust 100.00%

makurust's Introduction

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.

makurust's People

Contributors

fromgodd 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.