Skip to main content

Crate nargo_document

Crate nargo_document 

Source
Expand description

§Nargo Document - 文档生成库

提供 Markdown 文档的渲染和多种输出格式的生成功能,兼容 VuTeX 配置格式

§示例

use nargo_document::{config::Config, generator::Generator};

// 创建默认配置
let config = Config::default();

// 创建文档生成器
let mut generator = Generator::new(config);

// 生成文档
generator.generate(".", "dist").expect("Failed to generate documentation");

§功能特性

  • 支持 Markdown 渲染
  • 多种输出格式:HTML、PDF、静态文件
  • 主题系统支持
  • 插件扩展机制
  • 兼容 VuTeX 配置格式
  • 开发服务器支持

§主题

  • default - 默认主题
  • dark - 暗色主题
  • tech - 科技风主题

§插件

  • KaTeX - 数学公式渲染
  • Mermaid - 图表渲染
  • Prism - 代码高亮
  • Shiki - 代码高亮
  • Container - 容器组件

Re-exports§

pub use config::BuildConfig;
pub use config::Config;
pub use config::ConfigError;
pub use config::ConfigValidation;
pub use config::FooterConfig;
pub use config::LocaleConfig;
pub use config::MarkdownConfig;
pub use config::NavItem;
pub use config::PluginConfig;
pub use config::SidebarItem;
pub use config::ThemeConfig;
pub use generator::html::HtmlGenerator;
pub use generator::markdown::MarkdownRenderer;
pub use generator::pdf::PdfGenerator;
pub use generator::static_::StaticProcessor;
pub use generator::Generator;
pub use plugin::ContainerConfig;
pub use plugin::ContainerOptions;
pub use plugin::ContainerPlugin;
pub use plugin::DocumentPlugin;
pub use plugin::KaTeXPlugin;
pub use plugin::MermaidPlugin;
pub use plugin::PluginContext;
pub use plugin::PluginMeta;
pub use plugin::PluginRegistry;
pub use plugin::PrismPlugin;
pub use plugin::ShikiPlugin;
pub use server::DevServer;
pub use templates::Template;
pub use templates::TemplateColors;
pub use templates::TemplateConfig;
pub use templates::TemplateFeatures;
pub use templates::TemplateFonts;
pub use templates::TemplateI18n;
pub use theme::DarkTheme;
pub use theme::DefaultTheme;
pub use theme::LocaleInfo;
pub use theme::NavItem as ThemeNavItem;
pub use theme::PageContext;
pub use theme::SidebarGroup;
pub use theme::TechTheme;
pub use theme::Theme;
pub use theme::ThemeFactory;

Modules§

config
generator
plugin
插件模块 提供 nargo-document 文档编译器的插件系统
server
templates
模板系统模块 提供模板管理和渲染功能
theme
主题系统模块 提供主题管理和模板渲染功能,兼容 VuTeX 主题系统