GithubHelp home page GithubHelp logo

ange-cesari / schedariu Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 17 KB

Schedariu is a command line utility written in Rust, designed to convert Markdown files into HTML. The program provides two modes of operation, which can be invoked using command line flags:

License: MIT License

Rust 100.00%

schedariu's Introduction

Schedariu - A Markdown to HTML Converter

Schedariu is a command line utility written in Rust, designed to convert Markdown files into HTML. This utility is perfect for static site generation and other tasks that require bulk conversion of Markdown files into HTML.

Features

  • Converts a single Markdown file to HTML (SingleFile mode).
  • Converts a directory of Markdown files to HTML, preserving the original directory structure (MultipleFiles mode).
  • Robust error handling for file access and Markdown parsing errors.

Usage

You can use Schedariu via the command line with the following syntax:

SingleFile Mode

Use the single-file command followed by the input file path, output directory path, and desired output file name:

schedariu.exe single-file <input-file> <output-dir> <output-file-name>

Example:

schedariu.exe single-file /home/user/Documents/example.md /home/user/Output example.html

This will convert the example.md Markdown file into example.html in the Output directory.

MultipleFiles Mode

Use the multiple-files command followed by the input directory path and output directory path:

schedariu.exe multiple-files <input-dir> <output-dir>

Example:

schedariu.exe multiple-files /home/user/inputfolder /home/user/outputfolder

This will convert all Markdown files in the MarkdownFiles directory into HTML, preserving the original directory structure in the Output directory.

Building

To build Schedariu from source, you will need to have the Rust programming language installed. Once installed, you can build the project using the following command in the project root directory:

cargo build --release

The resulting executable will be placed in the ./target/release/ directory.

schedariu's People

Contributors

ange-cesari avatar

Stargazers

 avatar

Watchers

 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.