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

feat(v1): add deletedDocs config to escape from versioning fallback (#2955)

Browse source 
* feat: support for deletedDocs in siteConfig

fixes #2429

* docs: document deletedDocs option

* feat: allow array in deletedDocs config

* docs: clarify deletedDocs version formatting
This commit is contained in:
Eric Dobbertin 2020-06-25 10:54:49 -05:00 • committed by GitHub
parent bdffd28b9f
commit d513dec521
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 77 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

21
packages/docusaurus-1.x/lib/server/readMetadata.js
View file

@ -25,6 +25,15 @@ const utils = require('./utils.js');
const docsPart = `${siteConfig.docsUrl ? `${siteConfig.docsUrl}/` : ''}`;
// Get a list of all IDs that have been deleted in any version.
// We will assume these should not be in the current/next version.
const allDeletedIds = new Set();
if (siteConfig.deletedDocs) {
Object.values(siteConfig.deletedDocs).forEach((idList) => {
idList.forEach((id) => allDeletedIds.add(id));
});
}
const SupportedHeaderFields = new Set([
'id',
'title',
@ -238,6 +247,12 @@ function generateMetadataDocs() {
return;
}
const metadata = res.metadata;
if (
allDeletedIds.has(metadata.id) ||
(metadata.original_id && allDeletedIds.has(metadata.original_id))
) {
return;
}
metadatas[metadata.id] = metadata;
// create a default list of documents for each enabled language based on docs in English
@ -290,6 +305,12 @@ function generateMetadataDocs() {
return;
}
const metadata = res.metadata;
if (
allDeletedIds.has(metadata.id) ||
(metadata.original_id && allDeletedIds.has(metadata.original_id))
) {
return;
}
metadatas[metadata.id] = metadata;
}
});