chalk

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

Chalk 是一个高质量、完全可定制、性能优异且 100% 免费的 Jekyll 博客模板。

概述

功能：

• 关于页面。
• 自动 RSS 订阅。
• 自动网站地图。
• 自动显示文章阅读时间。
• 跨浏览器支持（支持所有现代浏览器）。
• 自定义 404 页面。
• 自定义代码高亮。
• 可定制的分页。
• 深色与浅色主题。
• 轻松设置与部署。
• 点击放大图片。
• 按标签过滤。
• 可选标签导航。
• 经常更新新版本。
• 支持多种社交媒体链接。
• 视频媒体嵌入。
• 优化 PageSpeed（页面速度）。
• 适用于 Facebook、Twitter 和 Google Plus 帖子的正确分享链接。
• SEO 优化。
• 支持本地字体。
• 支持表情符号。

集成

• Disqus
• 谷歌分析
• 谷歌字体
• SVG 图标

使用的工具

• Autoprefixer
• Circle CI
• Html-proofer
• Jekyll
• Jekyll Assets
• Jekyll Sitemap
• HTML5 Boilerplate（受其启发）
• Kickster
• Retina.js
• STACSS
• Travis
• Yarn
• Zooming

用法

安装

如果你还没有安装以下工具，请继续安装（确保你已经安装了 Homebrew）：

brew install ruby
brew install npm

在 Windows 上，使用以下链接中的安装程序安装 Ruby 和 Node：

• Ruby
• Node.js

接下来设置你的环境：

npm run setup

开发

运行 Jekyll：

npm run local

Deploy to GitHub Pages

在你部署之前，将你的更改提交到除 gh-pages 外的任意工作分支，然后运行以下命令：

npm run publish

重要提示：Chalk 不支持在 GitHub Pages 上使用标准方式托管 Jekyll。您需要使用 npm run publish 命令部署您的工作分支（可以是任何分支，对于 xxx.github.io 用户：使用除 master 之外的其他分支）。这是因为 Chalk 使用了 GitHub Pages 不支持的 Jekyll 插件。npm run publish 命令会自动构建整个项目，然后将其推送到您的仓库的 gh-pages 分支。该脚本会为您创建该分支，因此无需自己创建它。此外，如果您正在开发一个 项目站点，必须在 _config.yml 中将 baseurl 设置为您的仓库名称。

您可以在 这里 找到更多有关如何使用 gh-pages 分支和自定义域的信息。

查看此处 获取有关使用 Circle CI 自动部署的更多信息。

许可

MIT 许可证

贡献

1. Fork 它 (https://github.com/[my-github-username]/chalk/fork)
2. 创建您的功能分支 (git checkout -b my-new-feature)
3. 提交您的更改 (git commit -am 'Add some feature')
4. 推送到分支 (git push origin my-new-feature)
5. 创建新的拉取请求