docs: update readme
This commit is contained in:
parent
0245b9b2c4
commit
394c013fd2
1 changed files with 11 additions and 7 deletions
18
README.md
18
README.md
|
|
@ -1,11 +1,15 @@
|
|||
A Rust library for parsing org-mode files.
|
||||
# Orgize
|
||||
|
||||
[](https://crates.io/crates/orgize)
|
||||
[](https://docs.rs/orgize)
|
||||
[](https://github.com/PoiScript/orgize/actions/workflows/ci.yml)
|
||||
[](https://github.com/PoiScript/orgize/actions/workflows/ci.yml)
|
||||

|
||||
|
||||
# Parse
|
||||
A Rust library for parsing org-mode files.
|
||||
|
||||
Live Demo: <https://poiscript.github.io/orgize/>
|
||||
|
||||
## Parse
|
||||
|
||||
To parse a org-mode string, simply invoking the `Org::parse` function:
|
||||
|
||||
|
|
@ -45,7 +49,7 @@ let hdl = org.first_node::<Headline>().unwrap();
|
|||
assert_eq!(hdl.keyword().unwrap().text(), "TASK");
|
||||
```
|
||||
|
||||
# Render to html
|
||||
## Render to html
|
||||
|
||||
Call the `Org::to_html` function to export org element tree to html:
|
||||
|
||||
|
|
@ -60,8 +64,8 @@ assert_eq!(
|
|||
|
||||
Checkout `examples/html-slugify.rs` on how to customizing html export process.
|
||||
|
||||
# Features
|
||||
## Features
|
||||
|
||||
- `chrono`: adds the ability to convert `Timestamp` into `chrono::NaiveDateTime`, disabled by default.
|
||||
- **`chrono`**: adds the ability to convert `Timestamp` into `chrono::NaiveDateTime`, disabled by default.
|
||||
|
||||
- `indexmap`: adds the ability to convert `PropertyDrawer` properties into `IndexMap`, disabled by default.
|
||||
- **`indexmap`**: adds the ability to convert `PropertyDrawer` properties into `IndexMap`, disabled by default.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue