chris/orgize
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: update README.md and vscode icons

Browse source
This commit is contained in:
PoiScript 2023-12-21 23:51:42 +08:00
parent 0916b40cef
commit a2248cb9be
No known key found for this signature in database
GPG key ID: 22C2B1249D99985E
17 changed files with 66 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -1,71 +1,24 @@
# Orgize
[![Crates.io](https://img.shields.io/crates/v/orgize.svg)](https://crates.io/crates/orgize)
[![Documentation](https://docs.rs/orgize/badge.svg)](https://docs.rs/orgize)
[![Build status](https://img.shields.io/github/actions/workflow/status/PoiScript/orgize/ci.yml)](https://github.com/PoiScript/orgize/actions/workflows/ci.yml)
![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)
A Rust library for parsing org-mode files.
Org-mode toolkit written in Rust.
Live Demo: <https://poiscript.github.io/orgize/>
This repository contains several crates/packages:
## Parse
| Crates/packages | Description |
| ----------------------------- | ------------------------------------------------------------- |
| [`orgize`] | A pure-rust library for parsing and exporting org-mode files. |
| [`orgize-cli`] | Common line utility for org-mode files, builtin with orgize. |
| [`orgize-lsp`] | Language server for org-mode files, builtin with orgize. |
| [`orgize-lsp/editors/vscode`] | [`orgize-lsp`] client for vscode editor |
| [`orgize-common`] | Shared code for [`orgize-cli`] and [`orgize-lsp`]. |
| [`orgize-wasm`] | WebAssembly module for Browser or Node.js environment. |
To parse a org-mode string, simply invoking the `Org::parse` function:
```rust
use orgize::{Org, rowan::ast::AstNode};
let org = Org::parse("* DONE Title :tag:");
assert_eq!(
format!("{:#?}", org.document().syntax()),
r#"DOCUMENT@0..18
HEADLINE@0..18
HEADLINE_STARS@0..1 "*"
WHITESPACE@1..2 " "
HEADLINE_KEYWORD_DONE@2..6 "DONE"
WHITESPACE@6..7 " "
HEADLINE_TITLE@7..13
TEXT@7..13 "Title "
HEADLINE_TAGS@13..18
COLON@13..14 ":"
TEXT@14..17 "tag"
COLON@17..18 ":"
"#);
```
use `ParseConfig::parse` to specific a custom parse config
```rust
use orgize::{Org, ParseConfig, ast::Headline};
let config = ParseConfig {
// custom todo keywords
todo_keywords: (vec!["TASK".to_string()], vec![]),
..Default::default()
};
let org = config.parse("* TASK Title 1");
let hdl = org.first_node::<Headline>().unwrap();
assert_eq!(hdl.todo_keyword().unwrap(), "TASK");
```
## Render to html
Call the `Org::to_html` function to export org element tree to html:
```rust
use orgize::Org;
assert_eq!(
Org::parse("* title\n*section*").to_html(),
"<main><h1>title</h1><section><p><b>section</b></p></section></main>"
);
```
Checkout `examples/html-slugify.rs` on how to customizing html export process.
## Features
- **`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.
[`orgize`]: ./orgize
[`orgize-cli`]: ./orgize-cli
[`orgize-lsp`]: ./orgize-lsp
[`orgize-lsp/editors/vscode`]: ./orgize-lsp/editors/vscode
[`orgize-common`]: ./orgize-common
[`orgize-wasm`]: ./orgize-wasm