Crate oak_ascii_doc 

🛠️ Developer Guide

Ascii-doc 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:

1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
3. Scalability: Convenient for downstream tools to perform secondary development.

Re-exports

pub use crate::ast::AsciiDocRoot;

pub use crate::builder::AsciiDocBuilder;

pub use crate::lexer::AsciiDocLexer;

pub use crate::lexer::token_type::AsciiDocTokenType;

pub use crate::parser::AsciiDocParser;

pub use parser::element_type::AsciiDocElementType;

Modules

ast

AST definitions for AsciiDoc.

builder

Builder for the AsciiDoc AST.

lexer

Lexer for AsciiDoc.

lsp

LSP and IDE support for AsciiDoc.

parser

Parser for AsciiDoc.

Structs

AsciiDocLanguage

AsciiDoc language definition.