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

[V2] Adding "Draft" header option for Blog #2314

Closed
tomtongue opened this issue Feb 23, 2020 · 3 comments · Fixed by #2335
Closed

[V2] Adding "Draft" header option for Blog #2314

tomtongue opened this issue Feb 23, 2020 · 3 comments · Fixed by #2335
Labels
difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@tomtongue
Copy link

tomtongue commented Feb 23, 2020

🚀 Feature

Draft post mode for Blog such as draft: true
This option enable to avoid publishing a post if the post has draft: true in the Header option.

Currently, Header options for Blog does not support "draft" tag such as that of Jekyll; Posts | Jekyll • Simple, blog-aware, static sites, as shown in Blog | Docusaurus.

Have you read the Contributing Guidelines on issues?

Yes.

Motivation

Docusaurus enables us to create one of the most beautiful and useful documentation and blog site. However, when we use this as a Blog site and try to create a new blog post, we need to create a (or some) new branch(es) and then merge the master branch (as one of the example). It need more steps, compared with Jekyll. This functionality should help many users.

Pitch

Draft mode provides more easily to use it by blog user, team and so on.

  • Providing more easy publish
  • More easy to manage posts
  • Possibly avoiding to create many branches
@tomtongue tomtongue 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 Feb 23, 2020
@lex111
Copy link
Contributor

lex111 commented Feb 23, 2020

You can create any directory (for example, drafts) in the directory with the blog posts (blog) and move posts there that should not be published yet (blog/drafts/post.md).

@yangshun
Copy link
Contributor

I think they want to be able to preview drafts during dev as well. I remember trying to implement drafts before but wasn't too successful due to how the tags data was processed. Not against this idea and following the Jekyll convention would be good.

@yangshun yangshun added difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. and removed status: needs triage This issue has not been triaged by maintainers labels Feb 23, 2020
@lex111 lex111 added this to the v2.0.0-alpha.44 milestone Feb 23, 2020
@tomtongue
Copy link
Author

Thank you! Yes, currently, I'll create drafts directory and put drafts on the directory. Do you think it is needed to add the current document? If needed, I'll send pull request for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: intermediate Issues that are medium difficulty level, e.g. moderate refactoring with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants