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

Allow hiding of single articles via frontmatter #5882

Closed
1 of 2 tasks
Zenahr opened this issue Nov 5, 2021 · 1 comment
Closed
1 of 2 tasks

Allow hiding of single articles via frontmatter #5882

Zenahr opened this issue Nov 5, 2021 · 1 comment
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@Zenahr
Copy link
Contributor

Zenahr commented Nov 5, 2021

Have you read the Contributing Guidelines on issues?

Description

While writing docs it often is necessary to completely hide references to articles temporarily (in-between publishing doc updates).

It is possible to fully customize what articles show up via the sidebar config file, but AFAIK it is not possible to hide single articles via the YAML frontmatter in such a manner:

---
sidebar_position: 1
title: some title
hidden: true
---

other option names could be:

  • publish
  • draft

In essence what this would do is not take the markdown file into account when generating the static HTML or when deploying the webapp.

Has this been requested on Canny?

No response

Motivation

This helps in simplifying documentation management in general for larger projects. It often is the case that writers draft new documents but these new docs shouldn't show up online. This could be solved via separating the new work into its own branch but this is rather clumsy.

API design

---
sidebar_position: 1
title: some title
hidden: true
---

Have you tried building it?

No response

Self-service

  • I'd be willing to contribute this feature to Docusaurus myself.
@Zenahr Zenahr added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Nov 5, 2021
@Josh-Cena
Copy link
Collaborator

Closing in favor of #3417 and #5701

@Josh-Cena Josh-Cena added closed: duplicate This issue or pull request already exists in another issue or pull request and removed status: needs triage This issue has not been triaged by maintainers labels Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

2 participants