Notist
On this page
  1. Notist Documentation

Notist Documentation

  • Cook Book：从示例开始编写文档。

  • Notist CLI：站点构建、预览、单文件检查与调试、诊断与退出码。

  • Notist.toml 配置：package / site / extensions 的字段、默认值、路径基准与输出规则。

  • 扩展 Notist（Experimental）：文档层扩展点、配置与执行顺序、stdio 协议边界。

  • SSG Extension（Experimental）：Notist SSG 的构建生命周期、阶段输入与 JSON Lines 事件协议。

  • 从 Cargo examples 生成站点：通过 CLI 扩展读取清单与源码，在内存中生成页面及模板数据。

  • Markup Syntax：.not 的词法、调用、注解与通用解析规则，以及 Markdown 扩展语法。

  • Code Syntax：.notc 的签名声明、类型引用、CST / AST 与错误恢复。

  • Code 函数系统：Type 类型值、编译期实参、函数检查、森林插值与调用边界，以及求值前后的 Item 契约。

  • Option 类型：可选参数与缺席值。

  • Types & Literals：类型、字面量与内容 flavor。

  • Builtin BlockContent Functions & Sugar Grammar：每个内置函数的完整签名、语法糖与降糖规则。

  • Grammar Notation：阅读和编写语法规范使用的记法。

  • Grammar 模块：文法铁路图的 Rust / WASM 实现、构建与可运行示例。

  • Crate Architecture：当前 crate 与模块职责、依赖方向及 API / 宿主边界。

  • Document Frontends：默认前端、主树与关联内容树、内容字面量的解析 / lowering、注册与产物捕获。

  • Pipeline：Context 与宿主加载边界、现行入口、从源码到求值后 Item 的完整数据流与 Vault 内容边界。

  • Markup Pipeline：Markup 源码到 Item 的数据流、阶段契约、诊断与调试。

  • Code Pipeline：.notc 模块的 Parse / Lower、实例检查与 TypedExpr、诊断与求值边界。

  • 本地模块：相对路径 import、词法命名空间、输出配置与资源布局。

  • Vault 组件示例：在同一目录声明并实现 panel、badge，直接导入其他本地模块的图形组件，并使用输出数学映射。

  • 内容函数与输出绑定：原生内容函数的 HTML 绑定、组件参数协议与呈现生命周期。

  • 文档扩展（Experimental）：分阶段修改文档、Rust / stdio 接入、语义校验、输出编辑与 replace 执行映射。

  • HTML Rendering：最终内容树到 HTML 片段的转换与扩展入口。

  • Notist Book：书籍阅读结构、README 路由、SUMMARY.not、主题与构建流程。

  • Notist SSG：保持内容目录结构的 HTML 发布、站点模板、主题资源、数据、站点扩展与本地预览。

  • Package 与站点组织：一个包一个站点、多包独立构建与部署边界。

  • Draft：尚未确定的设计。

语法规则使用 Grammar Notation 表达；类型与字面量归 Types，具体函数及其语法糖归 Builtin，其他共用规则归 Syntax。函数小节引用共用规则，不重复定义。

_logs/ 保存历史记录；当前行为以规范和实现为准。