Add comments

This commit is contained in:
Frank Li 2017-08-15 16:55:38 -07:00
parent df0f95e36f
commit 43ef3c8142
22 changed files with 114 additions and 62 deletions

View file

@ -30,6 +30,7 @@ if (fs.existsSync(CWD + "/languages.js")) {
];
}
// returns map from id to object containing sidebar ordering info
function readSidebar() {
let allSidebars;
if (fs.existsSync(CWD + "/sidebars.json")) {
@ -69,6 +70,7 @@ function readSidebar() {
return order;
}
// split markdown header
function splitHeader(content) {
const lines = content.split("\n");
let i = 1;
@ -173,6 +175,7 @@ function processMetadata(file) {
return { metadata, rawContent: rawContent };
}
// process metadata for all docs and save into core/metadata.js
function generateDocsMetadata() {
const order = readSidebar();
@ -185,7 +188,7 @@ function generateDocsMetadata() {
const metadatas = {};
/* metadata for english files */
// metadata for english files
let files = glob.sync(CWD + "/../docs/**");
files.forEach(file => {
let language = "en";
@ -202,7 +205,7 @@ function generateDocsMetadata() {
}
});
/* metadata for non-english docs */
// metadata for non-english docs
files = glob.sync(CWD + "/translated_docs/**");
files.forEach(file => {
let language = "en";
@ -227,6 +230,7 @@ function generateDocsMetadata() {
}
});
// metadata for versioned docs
const versionData = versionFallback.docData();
versionData.forEach(metadata => {
const id = metadata.localized_id;
@ -262,6 +266,7 @@ function generateDocsMetadata() {
);
}
// process metadata for blog posts and save into core/MetadataBlog.js
function generateBlogMetadata() {
const metadatas = [];