Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Markdown Frontmatter #21

Open
1 of 5 tasks
oliver-pham opened this issue Oct 25, 2021 · 0 comments
Open
1 of 5 tasks

Support Markdown Frontmatter #21

oliver-pham opened this issue Oct 25, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@oliver-pham
Copy link
Owner

oliver-pham commented Oct 25, 2021

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:

---
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:

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

@oliver-pham oliver-pham added the enhancement New feature or request label Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant