opmark 0.0.3

An experimental markup language focused on presentation making
Documentation
  • Coverage
  • 50%
    36 out of 72 items documented6 out of 32 items with examples
  • Size
  • Source code size: 34.47 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 2.78 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Links
  • Homepage
  • fralonra/opmark
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • fralonra

OpMark

Latest version Documentation MIT

OpMark is an experimental markup language focused on presentation making. It's still in pre-alpha stage.

Features

  • Rich Text
  • Ordered/Unordered list
  • Image
  • Hyperlink

Example

A simple OpMark document

## This is Page 1

This is a simple example of *OpMark*.

---

## This is Page 2

### Rich Text
You can markup text using the following syntax:
*bold*
`code`
/italics/
$small$
~strikethrough~
_underline_

### Lists
You can make lists:

- unordered list

1. ordered list as well

### Images
![title of the image](src.png)

### Hyperlinks
[Github](https://github.com/)

WARN: OpMark uses different codes for EOL(end of line/line break) in different systems: \r\n(CRLF) in Windows, \n(LF) in others.

Using the parser

use opmark::Parser;
use std::{
    fs::read_to_string,
    path::Path,
};

fn main() {
    let path = Path::new("./foo/bar.opmark");
    let file_content = read_to_string(path).expect("Failed at reading file");
    let parser = Parser::new(file_content);
    for mark in parser {
        // do some stuff
    }
}