介绍
new-gatsby-post 是一个用于创建新的博客文章的npm包,基于gatsby和Markdown格式文件。该包可以帮助前端工程师快速创建和发布博客文章,提高博客内容的生产效率。
安装
可以通过npm或yarn进行全局安装:
npm install -g new-gatsby-post yarn global add new-gatsby-post
使用
使用new-gatsby-post的步骤如下:
- 打开终端或命令行窗口。
- 进入到blog博客目录,如:
cd ~/blog
。 - 执行
new-gatsby-post
命令:new-gatsby-post <文章标题>
。例如:
new-gatsby-post "使用new-gatsby-post创建新文章"
执行成功后,会在blog的content/posts
目录下生成新的Markdown格式文件。
深入了解
new-gatsby-post创建的文件结构
new-gatsby-post创建的Markdown格式文件结构如下:
-- -------------------- ---- ------- --- ------ ------ ----- ------------ ------------ ------ ----------- - -- - -- ----- - ------ - ---- ---
title
:文章标题。date
:文章创建时间。description
:文章描述,用于搜索引擎摘要展示。categories
:文章分类,可自定义。tags
:文章标签,可自定义。
创建自定义模板
可以通过修改new-gatsby-post创建的文件模板,实现自定义博客文章结构。如下,修改template.md
文件:
-- -------------------- ---- ------- --- ------ ------ ----- --- ---- --- ------------ ------ ----------- - --- - --- ----- - --- - --- --- -- ----- -- ----
修改完成后,用new-gatsby-post创建文章时就会使用自定义的模板。
修改默认文章目录
new-gatsby-post默认创建文章的目录为content/posts
,但是我们可以通过设置GATSBY_POSTS_PATH环境变量,将默认目录修改为自己指定的目录。例如:
export GATSBY_POSTS_PATH="~/my-blog/content/articles"
示例代码
在blog博客目录下执行以下命令,创建一篇名为使用new-gatsby-post创建新文章
的博客文章。
new-gatsby-post "使用new-gatsby-post创建新文章"
执行完命令后,会生成如下格式的Markdown文件:
-- -------------------- ---- ------- --- ------ ------------------------ ----- ------------ ------------ ------ ----------- - -- - -- ----- - ------ - ---- ---
文章标题、时间、描述、分类、标签都已经自动填充。我们只需要在下方编写博客内容即可。
总结
new-gatsby-post可以帮助前端工程师快速创建博客文章,提高博客内容的生产效率。同时,通过自定义模板和修改默认目录等方式,可以让new-gatsby-post更好地适应不同的博客环境。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056d4a81e8991b448e6f99