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

polish(v2): improve Docusaurus 1 to 2 migration developer experience (#2884)

Browse source 
* improve markdown parsing errors by adding file path to error

* typo commit

* Add default nav item position to right (as v1)

* improve error when sidebar references unexisting document

* parseMarkdownFile: improve errors by providing hint about using "" to avoid parsing errors, if using special characters

* improve subcategory migration error for Unknown sidebar item type

* improve unrecognizedFields error

* typo

* fix inline snapshots

* improve the migration docs

* improve the migration docs

* improve migration doc

* Update migrating-from-v1-to-v2.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
This commit is contained in:
Sébastien Lorber 2020-06-06 05:16:50 +02:00 • committed by GitHub
parent 8aa520c314
commit 1003a15d1f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 195 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

12
packages/docusaurus-plugin-content-docs/src/index.ts
View file

@ -275,16 +275,18 @@ export default function pluginContentDocs(
});
const convertDocLink = (item: SidebarItemDoc): SidebarItemLink => {
const linkID = item.id;
const linkMetadata = docsMetadataRaw[linkID];
const docId = item.id;
const docMetadata = docsMetadataRaw[docId];
if (!linkMetadata) {
if (!docMetadata) {
throw new Error(
`Improper sidebars file, document with id '${linkID}' not found.`,
`Bad sidebars file. The document id '${docId}' was used in the sidebar, but no document with this id could be found.
Available document ids=
- ${Object.keys(docsMetadataRaw).sort().join('\n- ')}`,
);
}
const {title, permalink, sidebar_label} = linkMetadata;
const {title, permalink, sidebar_label} = docMetadata;
return {
type: 'link',