Skip to content

kLiHz/mdbook-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdBook 模板

该内容使用 mdBook 构建 HTML 页面。

请修改根目录下的 book.toml 文件。

使用说明

在线浏览

本项目目前使用 GitHub Pages 进行托管,可以访问 mdBook 模板 - GitHub Pages 进行浏览。

自行构建

用户可以自行在本机上进行页面的构建和浏览。

首先将本项目 下载 / 克隆 至本地,之后:

  • 下载 mdBook 二进制文件,将其所在路径添加进 PATH 环境变量;
  • 切换到项目根目录,执行 mdbook serve 命令;
  • 在浏览器中访问 localhost:3000 即可阅览页面。

mdbook serve 默认侦听 localhost:3000。如需允许网络下其他设备访问,则需允许 mdbook 通过防火墙,并将 mdbook 的侦听地址设置为 0.0.0.0,端口号可自定义。参考命令如下:

$ mdbook serve -n 0.0.0.0 -p 3000

之后其他设备可以通过在浏览器中访问 http://[设备IP地址]:[端口号] 浏览页面。

亦可执行 mdbook build 命令,而后手动打开 book 目录下的 index.html 文件,开始阅览。

版权声明

除特别注明外,项目中除代码外的部分均在 CC BY-SA 4.0 协议之条款下提供。

Releases

No releases published

Packages

No packages published

Languages