You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Most static site generators (SSG) support front matter for adding metadata and custom variables to static sites. I think Docusaurus has done a great job implementing it.
---
id: doc-markdown
title: Docs Markdown Features
hide_title: false
hide_table_of_contents: false
sidebar_label: Markdown
sidebar_position: 3
pagination_label: Markdown features
custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md
description: How do I find you when I cannot solve this problem
keywords:
- docs
- docusaurus
image: https://i.imgur.com/mErPwqL.png
slug: /myDoc
---
# Markdown Features
My Document Markdown content
Describe the solution you'd like
Support parsing front matter for Markdown documents. It should accept the following fields:
tags: A list of strings or objects of two string fields label and permalink to tag to your docs.
Describe alternatives you've considered
Passing metadata and custom variables to configuration files is another option. However, that also requires maintaining configuration files along with the Markdown documents. This can end up in a mess if there are hundreds of configuration files and Markdown documents in a project. On the other hand, it should be easier to find and change a document's metadata if it's at the top of its content.
Is your feature request related to a problem? Please describe.
Most static site generators (SSG) support front matter for adding metadata and custom variables to static sites. I think Docusaurus has done a great job implementing it.
Example from Docusaurus:
Describe the solution you'd like
Support parsing front matter for Markdown documents. It should accept the following fields:
slug
field in Markdown front matter #22title
field in Markdown front matter #23hide_title
field in Markdown front matter #25description
field in Markdown front matter #24tags
: A list of strings or objects of two string fieldslabel
andpermalink
to tag to your docs.Describe alternatives you've considered
Passing metadata and custom variables to configuration files is another option. However, that also requires maintaining configuration files along with the Markdown documents. This can end up in a mess if there are hundreds of configuration files and Markdown documents in a project. On the other hand, it should be easier to find and change a document's metadata if it's at the top of its content.
Additional context
The text was updated successfully, but these errors were encountered: