mdBook 是一个基于 Markdown 文件的静态站点生成器,可以用于快速创建个人博客、文档页面或网站。下面是使用 mdBook 部署自己的网站的简要步骤:
-
创建 mdBook 项目:在你的本地电脑上创建一个新的 mdBook 项目,可以使用以下命令:
mdbook init mysite ```
这将在当前目录下创建一个名为 “mysite” 的新项目。
-
编写 Markdown 文件:在 mdBook 项目的 “src” 文件夹中编写 Markdown 格式的文档,这些文档将被自动转换为 HTML 页面。可以使用 Markdown 语法编写文档内容,也可以使用 mdBook 提供的一些特殊语法来设置页面布局、添加导航等。
-
预览站点:在本地预览生成的站点,可以使用以下命令:
mdbook serve --open
这将启动一个本地服务器,让你在浏览器中预览生成的站点,可以通过访问http://localhost:3000来查看。
-
构建网站:当你满意站点的外观和内容后,可以使用以下命令构建最终的静态网站文件:
mdbook build ```
这将生成一个名为 “dist” 的文件夹,其中包含生成的 HTML、CSS、JavaScript 等文件。
- 部署网站:将生成的 “dist” 文件夹上传到你的 Web 服务器或静态托管平台,例如 GitHub Pages、Netlify 等,即可将你的网站部署到互联网上。
这里将你的仓库上传到 github 之后,点击 setting,找到里面的 pags。 这里我们将使用 github Pages 来部署网站。
之后操作 build and deployment ,source 的来源选择 github action。
之后点击 mdBook 中的 configure,我们使用这里面的默认配置就可以。
之后提交完代码,等待 github action 运行结束我们就有了自己的网站主页了。