feat: add the ability to hide a document from the menu (#1354)

doczjs · Jan 12, 2020 · 95b0d7f · 95b0d7f
1 parent f0baf67
commit 95b0d7f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/core/docz-core/src/lib/Entry.ts b/core/docz-core/src/lib/Entry.ts
@@ -39,6 +39,7 @@ export class Entry {
   public readonly fullpath: string
   public readonly headings: Heading[]
   public readonly id: string
+  public readonly hidden: boolean
   public readonly menu: string | null
   public readonly name: string
   public readonly route: string
@@ -57,6 +58,7 @@ export class Entry {
     this.filepath = filepath
     this.fullpath = path.resolve(root, file)
     this.link = ''
+    this.hidden = parsed.hidden || false
     this.slug = this.slugify(filepath, config.separator)
     this.route = this.getRoute(parsed)
     this.name = name

diff --git a/core/gatsby-theme-docz/src/components/NavLink/index.js b/core/gatsby-theme-docz/src/components/NavLink/index.js
@@ -22,9 +22,14 @@ const getCurrentHash = () => {
 
 export const NavLink = React.forwardRef(({ item, ...props }, ref) => {
   const docs = useDocs()
+  const current = useCurrentDoc()
+
+  if (item.hidden) {
+    return null
+  }
+
   const to = item.route
   const headings = docs && getHeadings(to, docs)
-  const current = useCurrentDoc()
   const isCurrent = item.route === current.route
   const showHeadings = isCurrent && headings && headings.length > 0
   const currentHash = getCurrentHash()