opmark

Crates.ioopmark
lib.rsopmark
version0.0.3
sourcesrc
created_at2022-02-26 14:53:55.853012
updated_at2022-06-02 09:11:45.040582
descriptionAn experimental markup language focused on presentation making
homepagehttps://github.com/fralonra/opmark
repositoryhttps://github.com/fralonra/opmark
max_upload_size
id539975
size34,789
fralonra (fralonra)

documentation

README

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
    }
}
Commit count: 6

cargo fmt