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

feat: allow custom docsUrl & custom permalink

Browse source
This commit is contained in:
endiliey 2018-09-12 01:00:31 +08:00
parent 185f7b1ed1
commit b99605f725
12 changed files with 270 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/load/config.js
View file

@ -24,7 +24,9 @@ module.exports = function loadConfig(siteDir, deleteCache = true) {
'highlight',
'markdownPlugins',
'configureWebpack',
'chainWebpack'
'chainWebpack',
'docsUrl',
'customFields'
];
const missingFields = requiredFields.filter(field => !config[field]);
if (missingFields && missingFields.length > 0) {
@ -33,8 +35,16 @@ module.exports = function loadConfig(siteDir, deleteCache = true) {
);
}
/*
User's own array of custom fields,
e.g: if they want to include some field so they can access it later from `props.siteConfig`
*/
const {customFields = []} = config;
/* We don't allow useless/ not meaningful field */
const allowedFields = [...requiredFields, ...optionalFields, ...customFields];
const uselessFields = Object.keys(config).filter(
field => ![...requiredFields, ...optionalFields].includes(field)
field => !allowedFields.includes(field)
);
if (uselessFields && uselessFields.length > 0) {
throw new Error(