fredrikekre GitHub avatar

DocumenterCodeBlocks.jl

fredrikekre

一个Julia包,增强Documenter.jl文档中的代码块,提供行号、引用链接、工具提示和语法高亮。

Stars

9

7 天增长

暂无数据

Fork 数

0

开放 Issue

0

开源协议

MIT

最近更新

2026-07-28

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

为Julia文档添加交互功能,例如GitHub风格的可链接行、悬停工具提示以及方法感知的引用链接,显著提升导航和阅读体验。

适合谁使用

  • 使用Documenter.jl的Julia包开发者
  • 撰写Julia文档的技术作者
  • 阅读并交互Julia文档的用户
  • 大型Julia项目的维护者

典型使用场景

  • 编写带有可点击引用链接的API文档
  • 通过行永久链接改进代码示例的分享
  • 为标识符提供显示签名和摘要的悬停提示
  • 通过构建时警告确保文档字符串质量

项目优势

  • GitHub风格的行永久链接和行号选择
  • 函数参数感知的引用链接,跳转到正确方法
  • 构建时使用JuliaSyntax.jl进行语法高亮
  • 悬停提示显示方法签名和一行摘要

使用前须知

  • 依赖Documenter未公开的内部API,可能因更新而失效
  • 仅支持Julia代码块(julia、julia-repl、jldoctest)
  • 需要Documenter.jl作为依赖

README 快速开始

Usage

项目描述

A Documenter.jl plugin for more flavorful code blocks