3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-07 05:12:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

Allow edit URL to be customized with doc metadata (#443)

Browse source
This commit is contained in:
Glavin Wiechert 2018-02-11 20:43:37 -04:00 • committed by Joel Marcey
parent 5e39b2e01f
commit 41750667cd
2 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api-doc-markdown.md
View file

@ -38,6 +38,18 @@ original_id: doc1
---
```
`custom_edit_url`: The url for editing this document. If this field is not present, the document's edit url will fallback to `editUrl` from optional fields of `siteConfig.js`. See [siteConfig.js](site-config.md) docs for more information.
For example:
```markdown
---
id: doc-markdown
title: Markdown Features
custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
---
```
### Blog Posts
Blog Posts use the following markdown header fields that are enclosed by a line `---` on either side:

10
lib/core/Doc.js
View file

@ -27,11 +27,11 @@ class Doc extends React.Component {
docSource = docSource.match(new RegExp(/version-.*\/(.*\.md)/, 'i'))[1];
}
let editLink = this.props.config.editUrl && (
<a
className="edit-page-link button"
href={this.props.config.editUrl + docSource}
target="_blank">
const editUrl =
this.props.metadata.custom_edit_url ||
(this.props.config.editUrl && this.props.config.editUrl + docSource);
let editLink = editUrl && (
<a className="edit-page-link button" href={editUrl} target="_blank">
{editThisDoc}
</a>
);