无法生成markdown front matter
Closed this issue · 5 comments
liuzw-cyy commented
您好!我参考了您的博客,但是在修改的时候,新建markdown文件时无法自动生成markdown front matter,请问一下这是什么原因
kuizuo commented
你要确保你的 markdown 文件的 前言元数据字段 如下:
---
title: Welcome Docusaurus v2
authors:
- slorber
- yangshun
- name: Joel Marcey
title: Co-creator of Docusaurus 1
url: https://github.com/JoelMarcey
image_url: https://github.com/JoelMarcey.png
tags: [hello, docusaurus-v2]
description: This is my first post on Docusaurus 2.
image: https://i.imgur.com/mErPwqL.png
hide_table_of_contents: false
---
不过由于你提供的信息较少,我并不知道你是创建博客还是文档,而没有自动生成 markdown front matter,如果可以的话,提供相关代码与截图。
liuzw-cyy commented
当我在本地启动项目时,在docs文件夹下面新建一个markdown文档,我想要它自动生成markdown front matter,而不是手动配置,应该怎么做。在项目中我没有找到此配置方法前言元数据字段
kuizuo commented
当你在 docs 下创建 markdown 文件时,并不是直接显示在页面上,你需要配置 侧边栏文件sidebars.js,手动地将文件按照 侧边栏对象 的格式添加上去。
你如果想要在自动在页面生成 markdown,你的侧边栏对象可以这么设置
{
label: 'xxx',
type: 'category',
link: {
type: 'generated-index',
},
items: [
{
type: 'autogenerated',
dirName: 'skill/xxx', // docs 的 目录位置
},
],
},
这样存放在 skill/xxx
目录下的 markdown 文件将会自动生成对应的文档页面,不过这样你就不可控制这个目录下的 所有 markdown 所对应左侧侧边栏的排序。
liuzw-cyy commented