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

breaking(v2): editUrl should point to website instead of docsDir to support editUrl in versioning/trans (#1958)

Browse source
This commit is contained in:
Endi 2019-11-11 21:24:04 +07:00 • committed by GitHub
parent 1235fc9f7e
commit 6a3efd5f3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 13 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -80,7 +80,7 @@ describe('processMetadata', () => {
test('docs with editUrl', async () => { test('docs with editUrl', async () => {
const editUrl = const editUrl =
'https://github.com/facebook/docusaurus/edit/master/website/docs/'; 'https://github.com/facebook/docusaurus/edit/master/website';
const source = path.join('foo', 'baz.md'); const source = path.join('foo', 'baz.md');
const data = await processMetadata({ const data = await processMetadata({
source, source,

7
packages/docusaurus-plugin-content-docs/src/metadata.ts
View file

@ -7,7 +7,7 @@
import fs from 'fs-extra'; import fs from 'fs-extra';
import path from 'path'; import path from 'path';
import {parse, normalizeUrl} from '@docusaurus/utils'; import {parse, normalizeUrl, posixPath} from '@docusaurus/utils';
import {DocusaurusConfig} from '@docusaurus/types'; import {DocusaurusConfig} from '@docusaurus/types';
import lastUpdate from './lastUpdate'; import lastUpdate from './lastUpdate';
@ -100,7 +100,10 @@ export default async function processMetadata({
} }
if (editUrl) { if (editUrl) {
metadata.editUrl = normalizeUrl([editUrl, source]); metadata.editUrl = normalizeUrl([
editUrl,
posixPath(path.relative(siteDir, filePath)),
]);
} }
if (metadata.custom_edit_url) { if (metadata.custom_edit_url) {

4
website/docs/advanced-plugins.md
View file

@ -131,9 +131,9 @@ module.exports = {
*/ */
path: 'docs', path: 'docs',
/** /**
* URL for editing docs, example: 'https://github.com/facebook/docusaurus/edit/master/website/docs/' * URL for editing website repo, example: 'https://github.com/facebook/docusaurus/edit/master/website/'
*/ */
editUrl: 'https://github.com/repo/project/website/docs/', editUrl: 'https://github.com/repo/project/website/',
/** /**
* URL route for the blog section of your site * URL route for the blog section of your site
* do not include trailing slash * do not include trailing slash

6
website/docs/migrating-from-v1-to-v2.md
View file

@ -274,6 +274,8 @@ Deprecated. Create a `CNAME` file in your `static` folder instead with your cust
#### `customDocsPath`, `docsUrl`, `editUrl`, `enableUpdateBy`, `enableUpdateTime` #### `customDocsPath`, `docsUrl`, `editUrl`, `enableUpdateBy`, `enableUpdateTime`
**BREAKING**: `editUrl` should point to (website) docusaurus project instead of `docs` directory.
Deprecated. Pass it as an option to `@docusaurus/preset-classic` docs instead: Deprecated. Pass it as an option to `@docusaurus/preset-classic` docs instead:
```jsx {9-22} ```jsx {9-22}
@ -287,9 +289,9 @@ module.exports = {
docs: { docs: {
// Equivalent to `customDocsPath`. // Equivalent to `customDocsPath`.
path: 'docs', path: 'docs',
// Equivalent to `editUrl` // Equivalent to `editUrl` but should point to `website` dir instead of `website/docs`
editUrl: editUrl:
'https://github.com/facebook/docusaurus/edit/master/website/docs/', 'https://github.com/facebook/docusaurus/edit/master/website',
// Equivalent to `docsUrl`. // Equivalent to `docsUrl`.
routeBasePath: 'docs', routeBasePath: 'docs',
// Remark and Rehype plugins passed to MDX. Replaces `markdownOptions` and `markdownPlugins`. // Remark and Rehype plugins passed to MDX. Replaces `markdownOptions` and `markdownPlugins`.

2
website/docusaurus.config.js
View file

@ -33,7 +33,7 @@ module.exports = {
path: 'docs', path: 'docs',
sidebarPath: require.resolve('./sidebars.js'), sidebarPath: require.resolve('./sidebars.js'),
editUrl: editUrl:
'https://github.com/facebook/docusaurus/edit/master/website/docs/', 'https://github.com/facebook/docusaurus/edit/master/website/',
showLastUpdateAuthor: true, showLastUpdateAuthor: true,
showLastUpdateTime: true, showLastUpdateTime: true,
}, },