Crate oak_markdown 

🛠️ Developer Guide

Markdown 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::MarkdownRoot;

pub use crate::builder::MarkdownBuilder;

pub use crate::language::MarkdownLanguage;

pub use crate::lexer::MarkdownLexer;

pub use crate::parser::MarkdownParser;

pub use crate::lsp::highlighter::MarkdownHighlighter;

pub use lexer::token_type::MarkdownTokenType;

pub use parser::element_type::MarkdownElementType;

Modules

ast

Abstract Syntax Tree for Markdown.

builder

Builder for constructing Markdown syntax trees.

language

The Markdown language implementation for Oaks.

lexer

Syntax kinds for Markdown. Lexer for tokenizing Markdown source.

lsp

Language Server Protocol support for Markdown.

mcp

MCP module.

parser

Parser for building Markdown syntax trees.