feat: hide edit link by page (close: vuejs#284)

achendrick · Apr 27, 2018 · ebc0953 · ebc0953
1 parent 31b8feb
commit ebc0953
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/default-theme-config/README.md b/docs/default-theme-config/README.md
@@ -321,6 +321,14 @@ module.exports = {
 }
 ```
 
+You can also hide the edit link on specific pages via `YAML front matter`:
+
+``` yaml
+---
+editLink: false
+---
+```
+
 ## Simple CSS Override
 
 If you wish to apply simple overrides to the styling of the default theme, you can create an `.vuepress/override.styl` file. This is a [Stylus](http://stylus-lang.com/) file but you can use normal CSS syntax as well.

diff --git a/lib/default-theme/Page.vue b/lib/default-theme/Page.vue
@@ -59,6 +59,7 @@ export default {
         docsBranch = 'master',
         docsRepo = repo
       } = this.$site.themeConfig
+      const hideEditLink = this.$page.frontmatter.editLink === false
 
       let path = normalize(this.$page.path)
       if (endingSlashRE.test(path)) {
@@ -67,7 +68,7 @@ export default {
         path += '.md'
       }
 
-      if (docsRepo && editLinks) {
+      if (docsRepo && editLinks && !hideEditLink) {
         const base = outboundRE.test(docsRepo)
           ? docsRepo
           : `https://github.com/${docsRepo}`