Expand description
§🛠️ Developer Guide
Org-mode support for the Oak language framework.
This directory contains the core logic implementation of the project. Below are instructions for a quick start.
§🚦 Quick Start
§Core API Usage
// Example: Basic calling workflow
fn main() {
// 1. Initialization
// 2. Execute core logic
// 3. Handle returned results
}§🔍 Module Description
- lib.rs: Exports public interfaces and core traits.
- parser/ (if exists): Implements specific syntax parsing logic.
- ast/ (if exists): Defines the syntax tree structure.
§🏗️ Architecture Design
The project follows the general architectural specifications of the Oak ecosystem, emphasizing:
- Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
- Fault Tolerance: Core logic is highly inclusive of erroneous input.
- Scalability: Convenient for downstream tools to perform secondary development.
Re-exports§
pub use crate::ast::OrgModeRoot;pub use crate::builder::OrgModeBuilder;pub use crate::language::OrgModeLanguage;pub use crate::lexer::OrgModeLexer;pub use crate::parser::OrgModeParser;pub use crate::lsp::highlighter::OrgModeHighlighter;pub use crate::lsp::OrgModeLanguageService;pub use crate::mcp::serve_org_mode_mcp;pub use lexer::token_type::OrgModeTokenType;pub use parser::element_type::OrgModeElementType;