Skip to main content

markdown

Attribute Macro markdown 

Source
#[markdown]
Expand description

Generate Markdown API documentation from an impl block.

Creates human-readable documentation that can be used with any static site generator (VitePress, Docusaurus, MkDocs, etc.).

§Example

use server_less::markdown;

struct UserService;

#[markdown(title = "User API")]
impl UserService {
    /// Create a new user
    fn create_user(&self, name: String, email: String) -> User { ... }

    /// Get user by ID
    fn get_user(&self, id: String) -> Option<User> { ... }
}

// Get markdown string
let docs = UserService::markdown_docs();

// Write to file
UserService::write_markdown("docs/api.md")?;