#jekyll #markdown #front-matter #cli #gatsby

应用 jekyll-to-gatsby

一个工具,用于批量更新 Jekyll 的 Markdown 文章,以便与 Gatsby 一起使用,并在 frontmatter 块中添加它们的日期

4 个版本 (有破坏性)

0.4.0 2021 年 8 月 7 日
0.3.0 2021 年 8 月 7 日
0.2.0 2021 年 8 月 6 日
0.1.0 2021 年 8 月 6 日

#2#jekyll

MIT 许可证

16KB
308

Jekyll to Gatsby

CLI 工具,用于批量更新 jekyll 的 Markdown 内容文件,使其可用于 Gatsby(更改日期和 slug)

用法

用 Rust 编写,可以使用 Cargo 运行

安装命令

cargo install jekyll-to-gatsby

运行命令

cd my-folder-with-posts
jekyll-to-gatsby

新文件应出现在 output 文件夹中

它做什么

给定一个 Jekyll Markdown 文章文件的目录,结构如下

- some-folder
  - 2012-02-23-a-post.md
  - 2020-06-12-another-post.md
  • 将批量处理文章,并将它们输出到 output 文件夹中(可配置),从文件名中提取日期。
  • 在每个文章的前面添加 date 字段,以便 Gatsby 可以找到日期。
  • 将 Jekyll 的 URL 中的 {{ site.url }}}} 语法替换为移除它。您可以将其之前的 Jekyll assets 文件夹移动到 Gatsby 的 static 文件夹,路径应该可以正常工作。

新结构(基于 Gatsby Starter Blog 使用的结构)

- some-folder
  - a-post
    - index.md
  - another-post
    - index.md

选项

使用 jekyll-to-gatsby --help

Read some lines of a file Get first n lines of a file

USAGE:
    jekyll-to-gatsby [FLAGS] [OPTIONS] [pattern]

FLAGS:
    -d, --clean-dir
            Clean output directory before starting

    -h, --help
            Prints help information

    -k, --keep-dates
            Keep dates in file names

    -f, --no-folders
            Don't create individual folders for articles.

    -s, --no-slug
            Don't add a slug to the frontmatter header

    -u, --no-url-replace
            Don't replace the jekyll {{site.baseurl}} syntax in URLs

    -V, --version
            Prints version information

    -v, --verbosity
            Pass many times for more log output

            By default, it'll only report errors. Passing `-v` one time also prints warnings, `-vv` enables info
            logging, `-vvv` debug, and `-vvvv` trace.

OPTIONS:
    -o, --output <results_dir>
            Custom output directory [default: output]


ARGS:
    <pattern>
            Custom glob pattern for finding markdown files. [default: **/*.md]

依赖项

~5–14MB
~154K SLoC