Minidown 项目使用教程

42 0 0

Minidown 项目使用教程

minidownMinidown is a lightweight & fast markdown parser, with complete GFM support.项目地址:https://gitcode.com/gh_mirrors/mi/minidown

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

Minidown 项目的目录结构如下：

minidown/ ├── LICENSE ├── README.md ├── _config.yml ├── _data/ │ └── members.yml ├── _drafts/ │ ├── begin-with-the-crazy-ideas.md │ └── on-simplicity-in-technology.md ├── _includes/ │ ├── footer.html │ └── header.html ├── _layouts/ │ ├── default.html │ └── post.html ├── _posts/ │ ├── 2007-10-29-why-every-programmer-should-play-nethack.md │ └── 2009-04-26-barcamp-boston-4-roundup.md ├── _sass/ │ ├── _base.scss │ └── _layout.scss ├── _site/ ├── .jekyll-cache/ ├── .jekyll-metadata ├── about.md ├── assets/ │ ├── css/ │ └── images/ └── index.md

目录介绍

LICENSE: 项目的许可证文件。
README.md: 项目的说明文档。
_config.yml: 项目的配置文件。
_data/: 存放项目的数据文件，如 members.yml。
_drafts/: 存放未发布的草稿文章。
_includes/: 存放可重用的 HTML 片段，如页眉和页脚。
_layouts/: 存放页面布局模板。
_posts/: 存放已发布的文章。
_sass/: 存放 SASS 样式文件。
_site/: Jekyll 生成的静态站点文件。
.jekyll-cache/: Jekyll 的缓存文件夹。
.jekyll-metadata: Jekyll 的元数据文件。
about.md: 关于页面的 Markdown 文件。
assets/: 存放项目的静态资源，如 CSS 和图片。
index.md: 首页的 Markdown 文件。

2. 项目的启动文件介绍

Minidown 项目的启动文件是 index.md，它是项目的入口文件，负责展示首页内容。

index.md 内容示例

--- layout: default title: 首页 --- # 欢迎来到 Minidown 这是一个使用 Jekyll 构建的简单静态站点。

3. 项目的配置文件介绍

Minidown 项目的配置文件是 _config.yml，它包含了项目的全局配置信息。

_config.yml 内容示例

title: Minidown email: your-email@example.com description: >- # this means to ignore newlines until "baseurl:" 这是一个使用 Jekyll 构建的简单静态站点。 baseurl: "" # the subpath of your site, e.g. /blog url: "http://example.com" # the base hostname & protocol for your site, e.g. http://example.com twitter_username: jekyllrb github_username: jekyll # Build settings markdown: kramdown theme: minima plugins: - jekyll-feed