今天我们来介绍一款号称是GitBook替代者的文档构件工具,它就是MdBook。 MdBook是一款使用Rust开发的文档构建工具,它特别轻量,不依赖开发环境,仅仅一个可执行文件就能完成文档构建。 2、MdBook实践 2.1、获取MdBook 我们从MdBook的Github release页面去根据操作系统下载我们需要的软件包即可。 下载解压后,就可以得到mdbook.exe,我们在mdbook.exe所在路径下直接使用mdbook.exe即可进行项目创建和开发了。 创建项目命令:mdbook.exe init . 我们向src中增加一个目录,然后向其中添加一个md文件,启动mdbook的开发服务器查看效果。 2.4、预览文档 命令:.\mdbook.exe serve .
目前使用比较火的自己发布博客框架,可能是 mdbook 吧。 本例子主要是使用这个编写了一些使用手册,由于mdbook一般来说需要接入一些统计分析之类的,为了避免重复工作,最好还是在一个模版上来完成这个事情,然后把多本书嵌入进来完成这个需求。 mdbook 的使用手册地址 https://rust-lang.github.io/mdBook/具体的使用问题比在细说,主要关注于如何在一个主题下编译发布多本书,涉及到使用 python 脚本,很多问题使用 _book__', book) doc = doc.replace('__title__', title) tf.write(doc) os.system('mdbook
下面我们来试用一下mdbook。 这里通过crates.io进行安装 cargo install mdbook 安装完成之后创建mdbook工程,类似于gitbook的使用,假设我们创建的mdbook工程名为hello-mdbook mdbook init hello-mdbook 创建完成之后的目录结构如下 ? 接下来可以使用build命令来创建完整版本book mdbook build 监听本地文件变化并重新渲染可以使用命令 mdbook watch 本地浏览器预览可以使用命令 mdbook serve 然后运行命令 mdbook test 运行结果如下 ? 如果我们的代码块有错误,那么运行mdbook test结果如下 ?
It’s a personal knowledge management solution (PKM). mdbook & mdbook-pdf & mdBook-pagetoc mdbook是Rust mdbook-pdf是生成pdf的插件。mdBook-pagetoc是生成页内目录的插件。mdbook-theme是theme仓库。 https://github.com/rust-lang/mdBook https://github.com/HollowMan6/mdbook-pdf https://github.com/JorelAli /mdBook-pagetoc https://github.com/zjp-CN/mdbook-theme zsh & ohmyzsh 默认shell从bash换到zsh,并安装ohmyzsh,感觉好用多了
michaelfbryan/mdbook-docker-image - 一个打包了mdbook和很多常用plugins的Docker Image michaelfbryan/mdbook-docker-image - A docker image with mdbook and several common plugins https://hub.docker.com/r/michaelfbryan/mdbook-docker-image mdbook-docker-image是一个一个打包了mdbook和很多常用plugins的Docker Image,包含如下应用库: mdbook mdbook-linkcheck mdbook-mermaid
comprehensive-rust/cd comprehensive-rust安装必要工具:使用 Cargo 安装所需的工具:cargo install mdbookcargo install --locked mdbook-svgbobcargo install --locked mdbook-i18n-helperscargo install --locked i18n-reportcargo install --locked mdbook-linkcheckcargo install --locked --path mdbook-exercisercargo install --locked --path mdbook-course运行测试:运行以下命令测试所有包含的 Rust 代码片段:mdbook test启动本地服务器:使用以下命令启动本地服务器并查看课程内容:mdbook serve课程内容将在 http://localhost:3000 上提供。 构建静态版本:使用以下命令构建课程的静态版本:mdbook build静态版本将生成在 book/ 目录中。
、易于理解且快速消化吸收的小型知识点 多样性覆盖:涵盖众多编程语言和技术领域,适合广泛读者群体使用 持续更新:提供稳定而持续地发布新 TILs 的渠道,并支持邮件订阅获取最新内容 rust-lang/mdBook [4] Stars: 14.0k License: MPL-2.0 picture mdBook 是一个用于从 Markdown 文件创建现代在线书籍的实用工具。 以下是 mdBook 的关键特性和核心优势: 现代化:mdBook 提供了许多与当今网络技术相适应的先进功能,如响应式布局、代码高亮显示等。
github 链接:https://github.com/pacak/cargo-show-asm mdbook-compress:mdbook 的 pdf 生成器 作者几乎完全使用 Rust 实现了这个 mdbook-compress 可以方便、定制化地为 mdbook 生成可以发布的 pdf,是一个挺实用的小工具,详细操作方式可以参考 github 主页。 github:https://github.com/RosiePuddles/mdbook-compress/
项目名称:MdBook 项目地址:https://github.com/rust-lang/mdBook 该项目是 Rust 官方开源的制作 Markdown 电子书工具,功能上类似 Gitbook。 具体如何使用可以进一步查看官方文档:https://rust-lang.github.io/mdBook/ 往期推荐 开源身份认证神器:KeyCloak,不用自己写权限中心了!
io_uring 的 Rust 生态盘点 io_uring | 用 Rust 实现基于 io_uring 的异步随机读文件 Rust 编译器专题 如何为 Rust 语言做贡献 | Part 1 本刊 mdbook 模版功能改进 mdbook 模版功能新增: 增加评论功能。 Rust中文论坛/公众号] C -->|Rust视界| F[Telegram] C -->|掘金| G[技术社区] C -->|语雀| H[在线文档] 欢迎大家直接使用本刊 mdbook
配合出版社排版模板同类项目对比项目可编程逻辑多格式支持模板与布局易学性输出性能Quarkdown✅ 完整支持✅ PDF/HTML✅ 拓展插件✅ Markdown 原生⚡ 快速Pandoc + Lua✅ 支持 Lua脚本✅ 多格式⚠️ 配置复杂▲ 不易中等mdBook 真正把编程逻辑集成进文档输出类型全面,一稿可编译多种终端Markdown 原生写法,让开发者轻松上手类似替代项目说明Pandoc + Lua filter:功能全面,但需写 Lua 脚本,学习成本较高;mdBook
01 | Mdbook XSS 漏洞 (RUSTSEC-2021-0001) ? 正好《Rust 中文精选(RustMagazine)》也用了 mdbook,不过读者朋友不用害怕,本刊用的 mdbook 是修补了该漏洞的版本。 漏洞描述: 问题版本的 mdBook 中搜索功能(在版本0.1.4中引入)受到跨站点脚本漏洞的影响,该漏洞使攻击者可以通过诱使用户键入恶意搜索查询或诱使用户进入用户浏览器来执行任意JavaScript代码 而mdbook中提供的js函数encodeURIComponent会转义除'之外的所有可能允许XSS的字符。因此,还需要手动将'替换为其url编码表示形式(%27)才能解决该问题。
我已经学习 Rust 大约一个星期了,我试图使用 Rust 模仿 MDBook 程序,并开发了一个类似的程序。通过这个项目我练习一些 Rust 的编程技能。 Typikon 名称源自 Typikon Book,这是一个类似于 MDBook 和 GitBook 的静态网站渲染工具,但它仅着重于将 Markdown 渲染到在线书中,并且比其他工具更易于使用。
经过各位小编的工作《 RustMagazine 中文精选 》2021 年第二期发布了,伴随着二月刊发布, mdbook 模版功能也有两个改进: 增加评论功能,评论会自动同步到 RustMagazine 欢迎大家直接使用本刊 mdbook 模版进行创作投稿发PR! 阅读:https://rustcc.cn/article?
对了,mdbook 似乎会对同一域名缓存上次使用的主题,如果你的浏览器没有自动切换到默认的 Colibri 主题,可在顶部勾选一下(否则 inline code 会难看) —— Colibri 主题是
mdBook[3] 使用Rust创建书籍的Markdown工具 https://rust-lang.github.io/mdBook/[4] mdBook是一个用于从Markdown文件创建在线书籍的实用工具 如果您有兴趣为mdBook的开发做出贡献,请查看贡献指南。 要构建这本书,需要使用mdBook,可以使用以下命令安装:cargo install mdbook --version。构建完成后,可以在book子目录中找到输出,然后通过浏览器查看。 首先,需要通过cargo安装mdbook,然后可以运行"mdbook build"来生成完成的书籍,存储在book/目录下。 如果需要,在本地构建和阅读该指南,需要安装mdBook 0.4,然后可以使用命令"mdbook serve --open"构建并在本地查看。
mdBook 中文文档 Rust 开发的可将 Markdown 文件创建为书籍的高性能工具,同步最新开发版。 Cargo 中文文档 Rust 构建工具,同步最新开发版。
MOKIT在线手册见 https://jeanwsr.gitlab.io/mokit-doc-mdbook/ 若有读者在发表的研究中使用了MOKIT的功能,请恰当引用之。 issue区提问 https://gitlab.com/jxzou/mokit/-/issues 引用MOKIT的已发表文章一览 https://jeanwsr.gitlab.io/mokit-doc-mdbook
comments/kwlpv3/great_improvement_in_rustdoc_performance_in_the/ Rust 书籍宝库 glynnormington整理了网络上大部分有关rust的mdbook
mdbook 版:https://zjp-cn.github.io/rust-note/forum/impl-const-param.html 背景与问题 const 在 Rust 中是一个关键字,而且总是围绕着常量表达式 f() {} } impl<const I: i32> Foo where Check<{ check(I) }>: Equal, { fn f() {} } // 后半部分代码已隐藏,见 mdbook