From a046ccccfb7d5a8ec82e8246c546d4946c08047a Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sun, 5 Apr 2020 17:18:28 +0800 Subject: [PATCH] docs(v2): document editUrl --- .../src/theme/BlogPostPage/index.js | 22 +++++++++++- .../src/theme/DocItem/index.js | 24 +++++++++++-- .../src/theme/EditPage/index.js | 36 ------------------- website/docs/using-plugins.md | 5 +++ 4 files changed, 48 insertions(+), 39 deletions(-) delete mode 100644 packages/docusaurus-theme-classic/src/theme/EditPage/index.js diff --git a/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js b/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js index 099c227540e2..b2d14bba3a7d 100644 --- a/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js +++ b/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js @@ -29,7 +29,27 @@ function BlogPostPage(props) { isBlogPostPage> - +
+ {editUrl && ( + + + + + + + Edit this page + + )} +
{(nextItem || prevItem) && (
diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js index d8631883469a..c96619e1cf06 100644 --- a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js +++ b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js @@ -13,7 +13,6 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import useBaseUrl from '@docusaurus/useBaseUrl'; import DocPaginator from '@theme/DocPaginator'; import useTOCHighlight from '@theme/hooks/useTOCHighlight'; -import EditPage from '@theme/EditPage'; import classnames from 'classnames'; import styles from './styles.module.css'; @@ -128,7 +127,28 @@ function DocItem(props) {
- + {editUrl && ( + + + + + + + Edit this page + + )}
{(lastUpdatedAt || lastUpdatedBy) && (
diff --git a/packages/docusaurus-theme-classic/src/theme/EditPage/index.js b/packages/docusaurus-theme-classic/src/theme/EditPage/index.js deleted file mode 100644 index 33b7bf1992c2..000000000000 --- a/packages/docusaurus-theme-classic/src/theme/EditPage/index.js +++ /dev/null @@ -1,36 +0,0 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -import React from 'react'; - -function EditPage({url}) { - return ( -
- {url && ( - - - - - - - Edit this page - - )} -
- ); -} - -export default EditPage; diff --git a/website/docs/using-plugins.md b/website/docs/using-plugins.md index cbce525bf1d1..4d9c9c1fc5da 100644 --- a/website/docs/using-plugins.md +++ b/website/docs/using-plugins.md @@ -149,6 +149,11 @@ module.exports = { * relative to site dir */ path: 'blog', + /** + * URL for editing a blog post, example: 'https://github.com/facebook/docusaurus/edit/master/website/blog/' + */ + editUrl: + 'https://github.com/facebook/docusaurus/edit/master/website/blog', /** * URL route for the blog section of your site * do not include trailing slash