feat(v2): add edit url in post page #2524

fanny · 2020-04-04T01:11:57Z

Motivation

Fix #2501

Add label option to edit page in blog as in doc

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

go to a post page

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

docusaurus-bot · 2020-04-04T01:14:56Z

Deploy preview for docusaurus-2 ready!

Built with commit 8e26f99

https://deploy-preview-2524--docusaurus-2.netlify.com

fanny · 2020-04-04T13:09:04Z

@yangshun I didn't found the part on the doc, that we mention about the blog config, to update. Only for the docs. Do you think that would it be nice add?

lex111

Need tests.

fanny · 2020-04-04T14:00:23Z

Hi @lex111. Do I need to implement jest tests? What type of test do you suggest?

lex111 · 2020-04-04T14:03:27Z

See test below as an example.

docusaurus/packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts

Lines 63 to 89 in 32c1a92

    
           test('docs with editUrl', async () => { 
        
             const editUrl = 
        
               'https://github.com/facebook/docusaurus/edit/master/website'; 
        
             const source = path.join('foo', 'baz.md'); 
        
             const options = { 
        
               routeBasePath, 
        
               editUrl, 
        
             }; 
        
             const data = await processMetadata({ 
        
               source, 
        
               refDir: docsDir, 
        
               context, 
        
               options, 
        
               env, 
        
             }); 
        
             expect(data).toEqual({ 
        
               id: 'foo/baz', 
        
               permalink: '/docs/foo/baz', 
        
               source: path.join('@site', routeBasePath, source), 
        
               title: 'baz', 
        
               editUrl: 
        
                 'https://github.com/facebook/docusaurus/edit/master/website/docs/foo/baz.md', 
        
               description: '## Images', 
        
             }); 
        
           });

packages/docusaurus-theme-classic/src/theme/EditPage/index.js

packages/docusaurus-plugin-content-blog/src/blogUtils.ts

packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js

lex111 · 2020-04-04T17:46:56Z

packages/docusaurus-theme-classic/src/theme/EditPage/index.js

+
+function EditPage({url}) {
+  return (
+    <div>


Remove redundant div.

yangshun

Thank you, this looks really good. But let's not touch the docs theme markup (extracting the utility function is fine, but leave the markup duplicated). We don't want to create too many theme components.

Few more things:

Document the new option in website/docs/using-plugins.md under the docs plugin section 😄
Add this option into the default templates (can be done in a follow up PR)

yangshun · 2020-04-05T04:30:04Z

packages/docusaurus-theme-classic/src/theme/DocItem/index.js

@@ -13,6 +13,7 @@ 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';


Just copy and paste this component, don't make a new component for this edit button. Anyway it should probably be called EditButton if we wanted to make it a component.

yangshun · 2020-04-05T04:30:25Z

packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js

@@ -26,12 +29,10 @@ function BlogPostPage(props) {
                isBlogPostPage>
                <BlogPostContents />
              </BlogPostItem>
-              {(metadata.nextItem || metadata.prevItem) && (
+              <EditPage url={editUrl} />


Just duplicate the SVG and the <a>

yangshun

I made some changes, let's merge this first.

You can make a follow up PR to add showReadingTime and editUrl to the templates 😁

facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 4, 2020

yangshun added this to the v2.0.0-alpha.51 milestone Apr 4, 2020

fanny changed the title ~~[WIP] Add edit url in post page~~ feat(v2): Add edit url in post page Apr 4, 2020

fanny marked this pull request as ready for review April 4, 2020 13:12

fanny requested review from lex111, wgao19 and yangshun as code owners April 4, 2020 13:12

lex111 suggested changes Apr 4, 2020

View reviewed changes

lex111 reviewed Apr 4, 2020

View reviewed changes

packages/docusaurus-theme-classic/src/theme/EditPage/index.js Outdated Show resolved Hide resolved

lex111 reviewed Apr 4, 2020

View reviewed changes

packages/docusaurus-plugin-content-blog/src/blogUtils.ts Outdated Show resolved Hide resolved

lex111 reviewed Apr 4, 2020

View reviewed changes

packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.js Outdated Show resolved Hide resolved

lex111 reviewed Apr 4, 2020

View reviewed changes

yangshun changed the title ~~feat(v2): Add edit url in post page~~ feat(v2): add edit url in post page Apr 5, 2020

yangshun suggested changes Apr 5, 2020

View reviewed changes

lex111 removed this from the v2.0.0-alpha.51 milestone Apr 5, 2020

fanny added 11 commits April 5, 2020 17:21

Add edit page url in docs

b8001fb

feat(v2): Create EditPage component

78292e1

feat(v2): Improve component

2e156af

Add test

c2f4197

çhore(v2): update description

c0e3292

çhore(v2): update url

1a8dfd3

fix(v2): test

00057e3

fix(v2): test

ef9c20c

feat(v2): change the prop of EditPage component

aeb1094

chore(v2): Remove packages

8ee19fb

feat(v2): Update old tests

07c77a8

fanny and others added 4 commits April 5, 2020 17:21

chore(v2): fix package

4f17dd8

fix(v2): fix editUrl

4d0126e

docs(v2): document editUrl

a046ccc

--

112f42b

yangshun force-pushed the feat/add-editurl-in-post branch from 30bfe7b to 112f42b Compare April 5, 2020 09:29

yangshun approved these changes Apr 5, 2020

View reviewed changes

--

8e26f99

yangshun merged commit 5e664a1 into facebook:master Apr 5, 2020

yangshun added the pr: new feature This PR adds a new API or behavior. label Apr 5, 2020

yangshun added this to the v2.0.0-alpha.51 milestone Apr 5, 2020

fanny mentioned this pull request Apr 5, 2020

feat(v2): add showReadingTime and editUrl to the templates #2541

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v2): add edit url in post page #2524

feat(v2): add edit url in post page #2524

fanny commented Apr 4, 2020 •

edited

Loading

docusaurus-bot commented Apr 4, 2020 •

edited

Loading

fanny commented Apr 4, 2020 •

edited

Loading

lex111 left a comment

fanny commented Apr 4, 2020 •

edited

Loading

lex111 commented Apr 4, 2020

lex111 Apr 4, 2020 •

edited

Loading

yangshun left a comment

yangshun Apr 5, 2020

yangshun Apr 5, 2020 •

edited

Loading

yangshun left a comment

feat(v2): add edit url in post page #2524

feat(v2): add edit url in post page #2524

Conversation

fanny commented Apr 4, 2020 • edited Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Related PRs

docusaurus-bot commented Apr 4, 2020 • edited Loading

fanny commented Apr 4, 2020 • edited Loading

lex111 left a comment

Choose a reason for hiding this comment

fanny commented Apr 4, 2020 • edited Loading

lex111 commented Apr 4, 2020

lex111 Apr 4, 2020 • edited Loading

Choose a reason for hiding this comment

yangshun left a comment

Choose a reason for hiding this comment

yangshun Apr 5, 2020

Choose a reason for hiding this comment

yangshun Apr 5, 2020 • edited Loading

Choose a reason for hiding this comment

yangshun left a comment

Choose a reason for hiding this comment

fanny commented Apr 4, 2020 •

edited

Loading

docusaurus-bot commented Apr 4, 2020 •

edited

Loading

fanny commented Apr 4, 2020 •

edited

Loading

fanny commented Apr 4, 2020 •

edited

Loading

lex111 Apr 4, 2020 •

edited

Loading

yangshun Apr 5, 2020 •

edited

Loading