YaST

如何撰写新文章

关于撰写新博客文章的简短介绍

内容

创建新文章

基本上有两种方式可以撰写新的博客文章

  • 在本地 Git 检出中创建文章，并打开一个拉取请求（就像正常的代码更改一样）。
  • 直接在 GitHub 上创建文章，并在在线编辑器中编辑它。

本地创建文章

  • 在本地克隆 Git 仓库 并创建一个新分支
  • 在 _posts 目录中创建一个新的 Markdown 文件 - 遵循相同的文件命名模式，并像其他文章一样使用类似的 YAML 头部。（建议在线生成文章模板，请参阅上一节。）YAML 前置变量的值已部分记录在 这里 和 这里 甚至 这里。
  • 将图片添加到 /assets/images/blog/<YYYY>-<MM>-<DD> 子目录
  • 提示：如果您使用 Atom 编辑器，可以使用 实时预览功能 或 本地渲染页面。

在 GitHub 上创建文章

  • 打开 新建博客文章 页面
  • 填写表单并按下 生成模板 按钮
  • 您将被重定向到 GitHub，在那里将提出一个新的文章文件，模板将包含表单中的值。
  • 使用 预览更改 选项卡查看渲染后的 Markdown
    preview screenshot
  • 保存文件时，请在底部使用 为此提交创建一个新分支 选项
    commit screenshot
  • 然后，您可以打开一个拉取请求（如果文章已完成），或者继续编辑它（添加更多提交）。
  • 您可以使用仓库浏览器中的 上传文件 按钮上传图片

Markdown 提示

文档

该站点使用 Jekyll 框架生成页面，并使用 Kramdown 语法（一种 Markdown 风格）编写博客文章。

您可以在这里找到相关文档

图片

有一个 blog_img.md 包含文件，其中包含用于渲染本地图片的辅助工具。对于外部图片，请使用通常的 Markdown 语法，请参阅 下方。

内部图片

每篇博客文章都应在 /assets/images/blog/<YYYY>-<MM>-<DD> 子目录中包含相关的图片，最后一部分的日期应与文章文件名中的日期相同。

该辅助工具支持多种用例

  • 带有 alt 文本的简单图片，CSS 样式将最大宽度设置为 100%，因此图片不会溢出文本列
{% include blog_img.md alt="Alt text" src="file.png" %}
  • 缩小后的图片（缩略图大小），单击小图片将显示原始完整大小的图片
{% include blog_img.md alt="Alt text" src="file.png" attr=".thumbnail" %}
  • 单击显式提供的缩略图时将显示的图片
{% include blog_img.md alt="Alt text" src="file_small.png" full_img="file.png" %}

外部图片

对于外部图片（托管在博客外部），请使用通常的 ![]() Markdown 语法。如果您想为外部图片使用缩略图，请使用 Kramdown 属性扩展

![Alt](http://example.com/img.jpg){: .thumbnail}

请参阅 文档 以获取更多详细信息。

使用 post_url 辅助工具构建链接 URL，后跟文章文件名，不带 .md 后缀。

[old post link]({{ site.baseurl }}{% post_url 2015-12-15-let-s-blog-about-yast %})

语法高亮

像在 GitHub 上一样使用通常的围栏代码块

```ruby
puts "Hello world!"
```

渲染为

puts "Hello world!"

或者这个例子

```xml
<foo bar="yes">baz</foo>
```

渲染为

<foo bar="yes">baz</foo>

Emoji 表情

使用像 GitHub 一样的 emoji 快捷方式：:smiley: :smiley:，:wink: :wink:，:+1: :+1:，:sparkles: :sparkles:…

请参阅 emoji 备忘单 页面以获取完整的列表。

本地渲染页面

使用 bundler 安装 Jekyll 和所需的库

bundle install --path .vendor/bundle

构建页面

bundle exec jekyll build

生成的 HTML 页面保存到 _site 子目录中。

为了避免每次更改后手动重建页面，您可以运行带有 --watch 选项的 Jekyll 服务器

bundle exec jekyll serve --watch

这将自动在更改文件时重建页面。这也会在 http://127.0.0.1:4000/ 处运行一个 Web 服务器，以便您可以浏览生成的树。

持续集成

Travis CI 在将提交推送到 GitHub 仓库或打开新的拉取请求时运行一些测试。

本地运行检查

首先安装所需的依赖项

sudo zypper install aspell aspell-en aspell-devel

然后安装所需的 Ruby gems（如果您尚未这样做）。

bundle install --path .vendor/bundle

然后运行检查

bundle exec rake