gitksqc / shiva Goto Github PK

View Code? Open in Web Editor NEW

This project forked from igumnoff/shiva

Shiva library: Implementation in Rust of a parser and generator for documents of any type

License: GNU General Public License v3.0

Rust 100.00%

shiva's Introduction

Shiva

Shiva library: Implementation in Rust of a parser and generator for documents of any type

Features

Common Document Model (CDM) for all document types
Parsers produce CDM
Generators consume CDM

Supported document types

Document type	Parse	Generate
Plain text	+	+
Markdown	+	+
HTML	+	+
PDF	+	+
JSON	-	+
XML	-	-
DOC	-	-
XLS	-	-

Parse document features

Document type	Header	Paragraph	List	Table	Image	Hyperlink	PageHeader	PageFooter
Plain text	-	+	-	-	-	-	-	-
Markdown	+	+	+	+	+	+	-	-
HTML	+	+	+	+	+	+	-	-
PDF	-	+	+	-	-	-	-	-
Json	-	-	-	-	-	-	-	-

Generate document features

Document type	Header	Paragraph	List	Table	Image	Hyperlink	PageHeader	PageFooter
Plain text	+	+	+	+	-	+	+	+
Markdown	+	+	+	+	+	+	+	+
HTML	+	+	+	+	+	+	-	-
PDF	+	+	+	+	-	-	+	+
Json	+	+	+	+	+	+	+	+

Usage Shiva library

Cargo.toml

[dependencies]
shiva = {  version = "0.2.3", features = ["html", "markdown", "text", "pdf"] }

main.rs

fn main() {
    let input_vec = std::fs::read("input.html").unwrap();
    let input_bytes = bytes::Bytes::from(input_vec);
    let document = shiva::html::Transformer::parse(&input_bytes, &HashMap::new()).unwrap();
    let output_bytes = shiva::markdown::Transformer::generate(&document, &HashMap::new()).unwrap();
    std::fs::write("out.md", output_bytes).unwrap();
}

Shiva CLI

Install Rust for Linux/MacOS

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install Rust for Windows

https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe

Build executable Shiva

gti clone https://github.com/igumnoff/shiva.git
cd shiva/cli
cargo build --release

Run executable shiva

cd ./target/release/
./shiva --input-format=markdown --output-format=html --input-file=README.md --output-file=README.html

Who uses Shiva

Metatron library: Implementation in Rust of a report generation

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.

Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

TensorFlow

An Open Source Machine Learning Framework for Everyone

Django

The Web framework for perfectionists with deadlines.

Laravel

A PHP framework for web artisans

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.

Visualization

Some thing interesting about visualization, use data art

Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.

Microsoft

Open source projects and samples from Microsoft.

Google

Google ❤️ Open Source for everyone.

Alibaba

Alibaba Open Source for everyone

D3

Data-Driven Documents codes.

Tencent

China tencent open source team.