feat(gatsby-theme-docz): add showMarkdownEditButton flag

fixes #1291
doczjs · Nov 30, 2019 · 8fd04e8 · 8fd04e8
1 parent e8e86fc
commit 8fd04e8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/core/gatsby-theme-docz/src/components/Header/index.js b/core/gatsby-theme-docz/src/components/Header/index.js
@@ -10,7 +10,7 @@ export const Header = props => {
   const { onOpen } = props
   const {
     repository,
-    themeConfig: { showDarkModeSwitch },
+    themeConfig: { showDarkModeSwitch, showMarkdownEditButton },
   } = useConfig()
   const { edit = true, ...doc } = useCurrentDoc()
   const [colorMode, setColorMode] = useColorMode()
@@ -47,7 +47,7 @@ export const Header = props => {
             </button>
           )}
         </Flex>
-        {edit && doc.link && (
+        {showMarkdownEditButton && edit && doc.link && (
           <a
             sx={styles.editButton}
             href={doc.link}

diff --git a/core/gatsby-theme-docz/src/theme/index.js b/core/gatsby-theme-docz/src/theme/index.js
@@ -11,10 +11,16 @@ const typography = toTheme(moraga)
 
 export default merge(typography, {
   initialColorMode: 'light',
+  // Show errors above playground editor
   showLiveError: true,
+  // Show preview of the code inside playground
   showLivePreview: true,
+  // Show editor when a playground is rendered
   showPlaygroundEditor: true,
+  // Show dark/light mode switch toggle in header
   showDarkModeSwitch: true,
+  // Display edit this page button on every page
+  showMarkdownEditButton: true,
   colors: {
     ...modes.light,
     modes: {