1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
//! `OpMark` is an experimental markup language focused on presentation making.
//!
//! ## Features
//! - Rich Text
//! - Ordered/Unordered list
//! - Image
//! - Hyperlink
//!
//! # Example
//!
//! ## A simple OpMark document
//! ```text
//! ## 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
//! 
//!
//! ### Hyperlinks
//! [Github](https://github.com/)
//! ```
//!
//! ## 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
//! }
//! }
//! ```
pub mod mark;
mod parser;
pub use crate::parser::Parser;