Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sobird/inn
我的小酒馆
https://github.com/sobird/inn
Last synced: 6 days ago
JSON representation
我的小酒馆
- Host: GitHub
- URL: https://github.com/sobird/inn
- Owner: sobird
- License: mit
- Created: 2019-08-16T14:00:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T12:39:06.000Z (7 months ago)
- Last Synced: 2024-06-06T14:12:23.089Z (7 months ago)
- Language: JavaScript
- Homepage: https://sobird.github.io/inn/
- Size: 13.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 小酒馆 🍷
> 工作之余不妨来小酒馆里喝一杯
## 本地测试站点
```
jekyll serve
```
## Jekyll
### 环境要求
* Ruby version 2.5.0 or higher 查看版本 `ruby -v`
* RubyGems ruby 的包管理器，查看版本 `gem -v`
* GCC and Make 查看版本 `gcc -v`, `g++ -v`, and `make -v`
* Bundler 管理 Ruby 应用程序依赖的框架，查看版本 `bundle -v`
### 安装 ruby
```sh
# 查看ruby版本, 这是macOS自带的ruby不建议使用，
/usr/bin/ruby -v
ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.x86_64-darwin21]
# 查看gem版本
/usr/bin/gem -v
3.0.3.1
# 使用brew安装新的ruby
brew install ruby
# 查看安装后的版本
ruby -v
ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [x86_64-darwin21]
gem -v
3.5.4
# 升级gem到最新版本
gem update --system 3.5.9
```
### 安装jekyll 和 bundler
```sh
gem install jekyll bundler
# 查看 jekyll 版本
jekyll -v
jekyll 4.3.3
# 查看 bundler 版本
bundler -v
Bundler version 2.5.9
# 查看 jekyll 使用帮助
jekyll -h
jekyll 4.3.3 -- Jekyll is a blog-aware, static site generator in Ruby
Usage:
jekyll [options]
Options:
-s, --source [DIR] Source directory (defaults to ./)
-d, --destination [DIR] Destination directory (defaults to ./_site)
--safe Safe mode (defaults to false)
-p, --plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]] Plugins directory (defaults to ./_plugins)
--layouts DIR Layouts directory (defaults to ./_layouts)
--profile Generate a Liquid rendering profile
-h, --help Show this message
-v, --version Print the name and version
-t, --trace Show the full backtrace when an error occurs
Subcommands:
compose
docs
import
build, b Build your site
clean Clean the site (removes site output and metadata file) without building.
doctor, hyde Search site and print specific deprecation warnings
help Show the help message, optionally for a given subcommand.
new Creates a new Jekyll site scaffold in PATH
new-theme Creates a new Jekyll theme scaffold
serve, server, s Serve your site locally
```
### 创建一个Jekyll站点
```sh
# 根据上面的帮助命令提示，创建一个站点命令如下：
jekyll new my-jekyll
cd my-jekyll
# 初始化 Gemfile
bundle init
# 添加依赖包
bundle add jekyll
# 安装依赖
bundle update(install)
# 本地启动站点
bundle exec jekyll serve
```
Jekyll 要求博客文章的文件名按照以下格式命名：
`YEAR-MONTH-DAY-title.MARKUP`
* **YEAR** 4位数字，表示年份
* **MONTH** 2位数字，表示月份
* **DAY** 2为数字，表示日期
* **MARKUP** 表示文件扩展名
Jekyll 还提供了对代码片段的强大支持：
```ruby
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
```
## 语法高亮
Jekyll 3以上的版本默认集成了[Rouge](https://github.com/rouge-ruby/rouge)语法高亮组件。
### 安装 rouge
```sh
gem install rouge
# 使用rougify命令生成样式文件
rougify style monokai.sublime > syntax.css
```
## GitHub Pages
GitHub Pages 默认支持 `Jekyll` (静态网站生成器)，可自动将项目托管在 [GitHub Pages](https://pages.github.com/)，当然也可以使用其他静态站点生成器或者在本地或其他服务器上自定义构建发布过程。
* [支持的主题](https://pages.github.com/themes/)
* [支持的插件](https://pages.github.com/versions/)
## 参考
* [GitHub Pages 快速入门](https://docs.github.com/zh/pages/quickstart)
* [Jekyll docs][jekyll-docs]
* [使用 Jekyll 在本地测试 GitHub Pages 站点](https://docs.github.com/zh/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)
[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/