mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-31 09:57:03 +02:00
Use information from "docSidebar.js" file instead of doc front matters for sidebars.
This commit is contained in:
parent
69ba05e4f1
commit
abc5e325cd
9 changed files with 190 additions and 35 deletions
|
@ -87,12 +87,12 @@ function execute() {
|
|||
}
|
||||
|
||||
const readCategories = require("./readCategories.js");
|
||||
let layouts = {};
|
||||
let sidebars = {};
|
||||
for (let i = 0; i < Metadata.length; i++) {
|
||||
let layout = Metadata[i].layout;
|
||||
if (layouts[layout] !== true) {
|
||||
layouts[layout] = true;
|
||||
readCategories(layout);
|
||||
let sidebar = Metadata[i].sidebar;
|
||||
if (sidebars[sidebar] !== true) {
|
||||
sidebars[sidebar] = true;
|
||||
readCategories(sidebar);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ if (fs.existsSync(CWD + "/languages.js")) {
|
|||
}
|
||||
];
|
||||
}
|
||||
function readCategories(layout) {
|
||||
function readCategories(sidebar) {
|
||||
const enabledLanguages = [];
|
||||
languages.filter(lang => lang.enabled).map(lang => {
|
||||
enabledLanguages.push(lang.tag);
|
||||
|
@ -35,7 +35,7 @@ function readCategories(layout) {
|
|||
const language = enabledLanguages[k];
|
||||
|
||||
const metadatas = Metadata.filter(metadata => {
|
||||
return metadata.layout === layout && metadata.language === language;
|
||||
return metadata.sidebar === sidebar && metadata.language === language;
|
||||
});
|
||||
|
||||
// Build a hashmap of article_id -> metadata
|
||||
|
@ -91,7 +91,7 @@ function readCategories(layout) {
|
|||
}
|
||||
|
||||
fs.writeFileSync(
|
||||
__dirname + "/../core/" + layout + "Categories.js",
|
||||
__dirname + "/../core/" + sidebar + "Categories.js",
|
||||
"/**\n" +
|
||||
" * @generated\n" +
|
||||
" */\n" +
|
||||
|
|
|
@ -12,6 +12,8 @@ const CWD = process.cwd();
|
|||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
const os = require("os");
|
||||
const sidebar = require(CWD + "/docSidebar.js");
|
||||
const glob = require("glob");
|
||||
let languages;
|
||||
if (fs.existsSync(CWD + "/languages.js")) {
|
||||
languages = require(CWD + "/languages.js");
|
||||
|
@ -24,7 +26,37 @@ if (fs.existsSync(CWD + "/languages.js")) {
|
|||
}
|
||||
];
|
||||
}
|
||||
const glob = require("glob");
|
||||
|
||||
function readSidebar(allSidebars) {
|
||||
const order = {};
|
||||
|
||||
Object.keys(allSidebars).forEach(sidebar => {
|
||||
const categories = allSidebars[sidebar];
|
||||
|
||||
let ids = [];
|
||||
let categoryOrder = [];
|
||||
Object.keys(categories).forEach(category => {
|
||||
ids = ids.concat(categories[category]);
|
||||
for (let i = 0; i < categories[category].length; i++) {
|
||||
categoryOrder.push(category);
|
||||
}
|
||||
});
|
||||
|
||||
for (let i = 0; i < ids.length; i++) {
|
||||
const id = ids[i];
|
||||
let previous, next;
|
||||
if (i > 0) previous = ids[i - 1];
|
||||
if (i < ids.length - 1) next = ids[i + 1];
|
||||
order[id] = {
|
||||
previous: previous,
|
||||
next: next,
|
||||
sidebar: sidebar,
|
||||
category: categoryOrder[i]
|
||||
};
|
||||
}
|
||||
});
|
||||
return order;
|
||||
}
|
||||
|
||||
function splitHeader(content) {
|
||||
const lines = content.split(os.EOL);
|
||||
|
@ -84,20 +116,29 @@ function processMetadata(file) {
|
|||
// change ids previous, next
|
||||
metadata.localized_id = metadata.id;
|
||||
metadata.id = language + "-" + metadata.id;
|
||||
if (metadata.previous) {
|
||||
metadata.previous_id = metadata.previous;
|
||||
metadata.previous = language + "-" + metadata.previous;
|
||||
}
|
||||
if (metadata.next) {
|
||||
metadata.next_id = metadata.next;
|
||||
metadata.next = language + "-" + metadata.next;
|
||||
}
|
||||
metadata.language = language;
|
||||
|
||||
const order = readSidebar(sidebar);
|
||||
const id = metadata.localized_id;
|
||||
|
||||
metadata.sidebar = order[id].sidebar;
|
||||
metadata.category = order[id].category;
|
||||
|
||||
if (order[id].next) {
|
||||
metadata.next_id = order[id].next;
|
||||
metadata.next = language + "-" + order[id].next;
|
||||
}
|
||||
if (order[id].previous) {
|
||||
metadata.previous_id = order[id].previous;
|
||||
metadata.previous = language + "-" + order[id].previous;
|
||||
}
|
||||
|
||||
return { metadata, rawContent: rawContent };
|
||||
}
|
||||
|
||||
function generateDocsMetadata() {
|
||||
const order = readSidebar(sidebar);
|
||||
|
||||
const regexSubFolder = /docs\/(.*)\/.*/;
|
||||
|
||||
const enabledLanguages = [];
|
||||
|
@ -126,7 +167,7 @@ function generateDocsMetadata() {
|
|||
if (!res) {
|
||||
return;
|
||||
}
|
||||
const metadata = res.metadata;
|
||||
let metadata = res.metadata;
|
||||
metadatas.push(metadata);
|
||||
}
|
||||
});
|
||||
|
@ -181,7 +222,9 @@ function generateBlogMetadata() {
|
|||
);
|
||||
}
|
||||
|
||||
module.exports.extractMetadata = extractMetadata;
|
||||
module.exports.processMetadata = processMetadata;
|
||||
module.exports.generateDocsMetadata = generateDocsMetadata;
|
||||
module.exports.generateBlogMetadata = generateBlogMetadata;
|
||||
module.exports = {
|
||||
extractMetadata,
|
||||
processMetadata,
|
||||
generateDocsMetadata,
|
||||
generateBlogMetadata
|
||||
};
|
||||
|
|
|
@ -17,7 +17,6 @@ function execute(port) {
|
|||
const fs = require("fs-extra");
|
||||
const os = require("os");
|
||||
const path = require("path");
|
||||
const readMetadata = require("./readMetadata.js");
|
||||
const toSlug = require("../core/toSlug.js");
|
||||
const mkdirp = require("mkdirp");
|
||||
const glob = require("glob");
|
||||
|
@ -70,22 +69,25 @@ function execute(port) {
|
|||
|
||||
/****************************************************************************/
|
||||
|
||||
let readMetadata;
|
||||
let Metadata;
|
||||
let readCategories;
|
||||
|
||||
function reloadMetadataCategories() {
|
||||
purgeCache("./readMetadata.js");
|
||||
readMetadata = require("./readMetadata.js");
|
||||
readMetadata.generateDocsMetadata();
|
||||
purgeCache("../core/metadata.js");
|
||||
Metadata = require("../core/metadata.js");
|
||||
purgeCache("./readCategories.js");
|
||||
readCategories = require("./readCategories.js");
|
||||
|
||||
let layouts = {};
|
||||
let sidebars = {};
|
||||
for (let i = 0; i < Metadata.length; i++) {
|
||||
let layout = Metadata[i].layout;
|
||||
if (layouts[layout] !== true) {
|
||||
layouts[layout] = true;
|
||||
readCategories(layout);
|
||||
let sidebar = Metadata[i].sidebar;
|
||||
if (sidebars[sidebar] !== true) {
|
||||
sidebars[sidebar] = true;
|
||||
readCategories(sidebar);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue