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

fix(v2): check for docs homepage correctly (#2777)

Browse source
This commit is contained in:
Alexey Pyltsyn 2020-05-20 11:18:56 +03:00 • committed by GitHub
parent d94a549cfb
commit e8f50af8f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 66 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -70,6 +70,8 @@ export default function pluginContentDocs(
opts: Partial<PluginOptions>, opts: Partial<PluginOptions>,
): Plugin<LoadedContent | null> { ): Plugin<LoadedContent | null> {
const options = {...DEFAULT_OPTIONS, ...opts}; const options = {...DEFAULT_OPTIONS, ...opts};
const homePageDocsRoutePath =
options.routeBasePath === '' ? '/' : options.routeBasePath;
if (options.admonitions) { if (options.admonitions) {
options.remarkPlugins = options.remarkPlugins.concat([ options.remarkPlugins = options.remarkPlugins.concat([
@ -337,16 +339,15 @@ export default function pluginContentDocs(
const genRoutes = async ( const genRoutes = async (
metadataItems: Metadata[], metadataItems: Metadata[],
): Promise<RouteConfig[]> => { ): Promise<RouteConfig[]> => {
const routes: RouteConfig[] = []; const versionsRegex = new RegExp(versionsNames.join('|'), 'i');
await metadataItems.forEach(async (metadataItem, i) => { const routes = await Promise.all(
metadataItems.map(async (metadataItem, i) => {
const isDocsHomePage = const isDocsHomePage =
metadataItem.id.substr(metadataItem.id.indexOf('/') + 1) === metadataItem.id.replace(versionsRegex, '').replace(/^\//, '') ===
options.homePageId; options.homePageId;
if (isDocsHomePage) { if (isDocsHomePage) {
const homeDocsRoutePath =
routeBasePath === '' ? '/' : routeBasePath;
const versionDocsPathPrefix = const versionDocsPathPrefix =
(metadataItem?.version === versioning.latestVersion (metadataItem?.version === versioning.latestVersion
? '' ? ''
@ -362,7 +363,7 @@ export default function pluginContentDocs(
docsBaseMetadata.isHomePage = true; docsBaseMetadata.isHomePage = true;
docsBaseMetadata.homePagePath = normalizeUrl([ docsBaseMetadata.homePagePath = normalizeUrl([
baseUrl, baseUrl,
homeDocsRoutePath, homePageDocsRoutePath,
versionDocsPathPrefix, versionDocsPathPrefix,
options.homePageId, options.homePageId,
]); ]);
@ -375,7 +376,7 @@ export default function pluginContentDocs(
addRoute({ addRoute({
path: normalizeUrl([ path: normalizeUrl([
baseUrl, baseUrl,
homeDocsRoutePath, homePageDocsRoutePath,
versionDocsPathPrefix, versionDocsPathPrefix,
]), ]),
component: docLayoutComponent, component: docLayoutComponent,
@ -394,21 +395,26 @@ export default function pluginContentDocs(
JSON.stringify(metadataItem, null, 2), JSON.stringify(metadataItem, null, 2),
); );
// Do not create a route for a page created specifically for docs home page. return {
if (metadataItem.id !== REVERSED_DOCS_HOME_PAGE_ID) {
routes.push({
path: metadataItem.permalink, path: metadataItem.permalink,
component: docItemComponent, component: docItemComponent,
exact: true, exact: true,
modules: { modules: {
content: metadataItem.source, content: metadataItem.source,
}, },
}); };
} }),
}); );
return routes.sort((a, b) => return (
a.path > b.path ? 1 : b.path > a.path ? -1 : 0, routes
// Do not create a route for a page created specifically for docs home page.
.filter(
({path}) =>
path.substr(path.lastIndexOf('/') + 1) !==
REVERSED_DOCS_HOME_PAGE_ID,
)
.sort((a, b) => (a.path > b.path ? 1 : b.path > a.path ? -1 : 0))
); );
}; };
@ -477,9 +483,8 @@ export default function pluginContentDocs(
}, },
async routesLoaded(routes) { async routesLoaded(routes) {
const normalizedHomeDocsRoutePath = `/${options.routeBasePath}`;
const homeDocsRoutes = routes.filter( const homeDocsRoutes = routes.filter(
(routeConfig) => routeConfig.path === normalizedHomeDocsRoutePath, (routeConfig) => routeConfig.path === homePageDocsRoutePath,
); );
// Remove the route for docs home page if there is a page with the same path (i.e. docs). // Remove the route for docs home page if there is a page with the same path (i.e. docs).
@ -487,7 +492,7 @@ export default function pluginContentDocs(
const docsHomePageRouteIndex = routes.findIndex( const docsHomePageRouteIndex = routes.findIndex(
(route) => (route) =>
route.component === options.docLayoutComponent && route.component === options.docLayoutComponent &&
route.path === normalizedHomeDocsRoutePath, route.path === homePageDocsRoutePath,
); );
delete routes[docsHomePageRouteIndex!]; delete routes[docsHomePageRouteIndex!];