Jekyll AsciiDoc 项目使用指南

Jekyll AsciiDoc 项目使用指南

jekyll-asciidoc:syringe: A Jekyll plugin that converts AsciiDoc source files in your site to HTML pages using Asciidoctor.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-asciidoc

1. 项目的目录结构及介绍

Jekyll AsciiDoc 项目的目录结构如下：

jekyll-asciidoc/
├── _config.yml
├── _layouts/
│   └── default.html
├── _posts/
├── css/
├── Gemfile
├── index.adoc
├── js/
├── LICENSE
├── README.adoc
└── Rakefile

目录结构介绍

• _config.yml: 项目的配置文件。
• _layouts/: 存放页面布局模板。
• _posts/: 存放博客文章。
• css/: 存放样式文件。
• Gemfile: 定义项目所需的 Ruby 依赖。
• index.adoc: 首页的 AsciiDoc 文件。
• js/: 存放 JavaScript 文件。
• LICENSE: 项目的许可证。
• README.adoc: 项目说明文档。
• Rakefile: 用于自动化任务的 Rake 文件。

2. 项目的启动文件介绍

项目的启动文件主要是 index.adoc，这是网站的首页内容。通过编辑这个文件，可以修改首页的展示内容。

index.adoc 文件介绍

= 首页标题
作者名
:toc:

这是首页的内容。

== 第一节
这里是第一节的内容。

== 第二节
这里是第二节的内容。

3. 项目的配置文件介绍

项目的配置文件是 _config.yml，它包含了 Jekyll 站点的所有配置选项。

_config.yml 文件介绍

title: 网站标题
email: 邮箱地址
description: 网站描述
baseurl: ""
url: "http://你的网站地址.com"
twitter_username: 你的Twitter用户名
github_username: 你的GitHub用户名

# 插件
plugins:
  - jekyll-asciidoc
  - jekyll-archives

# AsciiDoc 配置
asciidoc:
  attributes:
    - icons=font
    - source-highlighter=coderay

配置文件说明

• title: 网站的标题。
• email: 联系邮箱。
• description: 网站的描述。
• baseurl: 网站的基本路径。
• url: 网站的完整 URL。
• twitter_username: Twitter 用户名。
• github_username: GitHub 用户名。
• plugins: 使用的 Jekyll 插件。
• asciidoc: AsciiDoc 相关的配置，如使用的图标和代码高亮工具。

通过编辑 _config.yml 文件，可以调整网站的整体配置，包括标题、描述、插件等。

jekyll-asciidoc:syringe: A Jekyll plugin that converts AsciiDoc source files in your site to HTML pages using Asciidoctor.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-asciidoc