本页介绍如何安装Jekyll, 并在本地使用 wiki 作为 Git 存储库。
安装 Jekyll
jekyll 静态站点生成器可以安装在 Linux、MacOS 和 Windows 上。 需要安装 jekyll 的本地版本,请按照您的说明进行操作 各自的操作系统here。
克隆存储库
安装jekyll后,
clone
repository。导航到克隆的存储库并运行bundle install以
安装运行 jekyll 并为站点提供服务所需的特定 ruby gem。
安装完成后,最好运行bundle update
(最好经常bundle update以保持最新状态)。
提供站点的本地版本
现在 jekyll 和存储库都已安装在本地
计算机,您可以通过导航到本地站点来运行静态站点生成器
终端内的目录并运行 bundle exec jekyll serve。等待一个
网站生成后一分钟,然后在浏览器中导航到
终端中输出的服务器地址,即
http://127.0.0.1:4000。您对任何文件所做的更改
该目录将被jekyll检测到,并重新生成站点以反映
新变化。
或者,您可以运行 bundle exec jekyll serve --incremental 来启动
本地服务器。此命令将减少执行所需的时间
如果您预计会连续快速进行多次更改,则需要重新生成站点。
在 _pages 中创建一个新页面
在_pages下的所需文件夹中,创建一个新文本
文件——例如touch _pages/plugins/my-awesome-plugin.md。
Filenames should be lowercase, omit spaces, and use extension .md.
在本地编辑页面
我们建议使用 text editor 在本地工作时添加内容文本页面进行更改。 文本编辑器 可以在文件之间导航,在页面中搜索文本,以及 按钮编辑更加高效,并提供更加用户友好的界面。
从这里开始,front matter和 新页面的内容可以使用您选择的文本编辑器填充。
-
图片和其他媒体应存储在
/path/to/imagej.github.io/media中。 -
定期保存您的提交细节。提交您的流程 更改将您的编辑自定义到托管存储库的主要分支
GitHub。下面描述提交的过程。
创建扩展
例如,如果您想扩展 wiki 的功能,那么可以自定义 JavaScript 库加载到某些页面。
您可以将脚本添加到 _includes/extensions 中,然后用户可以通过将扩展名称添加到其 Markdown 文件的 Front Matter 中的 extensions 中来启用您的扩展。
例如,您可以在 _includes/extensions 文件夹中找到两个示例扩展 mathjax 和 imjoy。
在任何页面的引用中,您可以通过以下方式启用它们:
---
title: My Awesome Page
extensions: ["imjoy", "mathjax"]
---
使用 Git 进行主动、拉取和提交
一旦您准备好发布新页面,您将需要添加、提交、 把您的个体更改到存储库。这些步骤看起来应该有些东西 叽叽喳喳:
git add path/to/your-page-name.md此步骤将提交您的更改。git commit path/to/your-page-name.md注意:系统不会提示您输入提交消息。我们的用户身份使用祈使时态,即“添加新页面 xzy”git push您的新页面或编辑不会被自适应到存储库的主分支。
This guide补充规定
对上述步骤的解释,以及如何获取本地存储库
与派派保持最新状态git pull。