yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-06-27 05:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docusaurus (#2515)

Browse Source
This commit is contained in:
Harshal Sheth 2021-05-11 11:17:53 -07:00 committed by GitHub
parent 06299f97f1
commit 18ac4f319d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 1484 additions and 3061 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs-website/generateDocsDir.ts
View File

@ -303,8 +303,15 @@ for (const filepath of markdown_files) {
}
// Error if a doc is not accounted for in a sidebar.
const sidebar = fs.readFileSync(SIDEBARS_DEF_PATH).toString();
const autogenerated_sidebar_directories = ["docs/rfc/active/"];
for (const filepath of markdown_files) {
if (
autogenerated_sidebar_directories.some((dir) => filepath.startsWith(dir))
) {
// The sidebars for these directories is automatically generated,
// so we don't need check that they're in the sidebar.
continue;
}
if (!accounted_for_in_sidebar(filepath)) {
throw new Error(
`File not accounted for in sidebar ${filepath} - try adding it to docs-website/sidebars.js`

6
docs-website/package.json
View File

@ -15,9 +15,9 @@
"lint-check": "prettier -l generateDocsDir.ts sidebars.js src/pages/index.js"
},
"dependencies": {
"@docusaurus/core": "2.0.0-alpha.69",
"@docusaurus/plugin-ideal-image": "2.0.0-alpha.69",
"@docusaurus/preset-classic": "2.0.0-alpha.69",
"@docusaurus/core": "^2.0.0-alpha.75",
"@docusaurus/plugin-ideal-image": "^2.0.0-alpha.75",
"@docusaurus/preset-classic": "^2.0.0-alpha.75",
"clsx": "^1.1.1",
"react": "^16.12.0",
"react-dom": "^16.12.0"

9
docs-website/sidebars.js
View File

@ -1,7 +1,7 @@
const fs = require("fs");
function list_ids_in_directory(directory) {
const files = fs.readdirSync(`../${directory}`);
const files = fs.readdirSync(`../${directory}`).sort();
let ids = [];
for (const name of files) {
if (fs.lstatSync(`../${directory}/${name}`).isDirectory()) {
@ -10,12 +10,15 @@ function list_ids_in_directory(directory) {
ids = ids.concat(inner_ids);
} else {
if (name.endsWith(".md")) {
const id = `${directory}/${name}`.replace(/\.md$/, "");
const slug = name.replace(/\.md$/, "");
let id = `${directory}/${slug}`;
if (id.match(/\/\d+-.+/)) {
id = id.replace(/\/\d+-/, "/");
}
ids.push(id);
}
}
}
ids.sort();
return ids;
}

4521
docs-website/yarn.lock
View File

File diff suppressed because it is too large Load Diff