Support draft/hidden posts (#2049)

* support draft/hidden posts * add changeset --------- Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru> Co-authored-by: Dimitri POSTOLOV <dmytropostolov@gmail.com>
shuding · Aug 13, 2023 · 23c3d6a · 23c3d6a · vercel · Aug 13, 2023
1 parent a1cc984
commit 23c3d6a
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/.changeset/warm-pens-travel.md b/.changeset/warm-pens-travel.md
@@ -0,0 +1,5 @@
+---
+'nextra-theme-blog': minor
+---
+
+support draft posts via frontMatter's `draft: true` value
diff --git a/examples/blog/pages/posts/draft.mdx b/examples/blog/pages/posts/draft.mdx
@@ -0,0 +1,13 @@
+---
+title: Draft
+date: 2023/6/28
+description: An example of a draft post.
+draft: true
+tag: web development
+author: Ada Lovelace
+---
+
+Because this post has `draft: true` defined in its frontmatter, it won't show up
+in the [list of posts](/posts) or
+[list of posts by tag](/tags/web%20development) but can be access directly by
+its url at [/posts/draft](/posts/draft).
diff --git a/packages/nextra-theme-blog/src/utils/collect.ts b/packages/nextra-theme-blog/src/utils/collect.ts
@@ -14,8 +14,8 @@ const isPost = (page: PageMapItem): page is MdxFile => {
     page.name.startsWith('_')
   )
     return false
-  const type = page.frontMatter?.type
-  return !type || type === 'post'
+  const { draft, type } = page.frontMatter || {}
+  return !draft && (!type || type === 'post')
 }
 
 export const collectPostsAndNavs = ({ opts }: LayoutProps) => {