tauri-apps/typedocusaurus
1
0
Fork 0
mirror of https://github.com/tauri-apps/typedocusaurus.git synced 2026-02-04 02:31:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove reference to sidebarFile parameter

Browse Source
This commit is contained in:
Lorenzo Lewis
2022-01-19 09:16:23 +00:00
parent b86cb18d96
commit 2d771a8f4f
5 changed files with 4 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/test-action.yml vendored
View File

@@ -2,6 +2,7 @@ name: test action
on:
pull_request:
push:
jobs:
update-docs:
@@ -22,6 +23,5 @@ jobs:
uses: ./
with:
originPath: ./tauri/tooling/api/
sidebarFile: ./tauri-docs/sidebars/typedoc.json
targetPath: ./tauri-docs/docs/en/api/js/
targetPath: ./tauri-docs/docs/api/js/
docusaurusPath: ./tauri-docs/

2
action.yml
View File

@@ -3,8 +3,6 @@ description: 'Generate Typedoc to Docusaurus.'
inputs:
originPath:
required: true
sidebarFile:
required: true
targetPath:
required: true
docusaurusPath:

113
dist/index.js vendored
View File

@@ -453,7 +453,7 @@ module.exports = exports['default'];
/***/ }),
/***/ 879:
/***/ 895:
/***/ ((__unused_webpack_module, __webpack_exports__, __nccwpck_require__) => {
"use strict";
@@ -721,107 +721,6 @@ async function render(project, outputDirectory) {
}
}
// EXTERNAL MODULE: external "fs"
var external_fs_ = __nccwpck_require__(747);
;// CONCATENATED MODULE: ./src/sidebar.ts
var sidebar_decorate = (undefined && undefined.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
// @ts-ignore
// @ts-ignore
// @ts-ignore
// @ts-ignore
let SidebarComponent = class SidebarComponent extends output_components.RendererComponent {
initialize() {
// @ts-ignore
this.listenTo(this.application.renderer, {
[events.RendererEvent.BEGIN]: this.onRendererBegin,
});
}
async onRendererBegin(renderer) {
var _a;
// @ts-ignore
const navigation = (_a = this.application.renderer.theme) === null || _a === void 0 ? void 0 : _a.getNavigation(renderer.project);
const out = this.out.match(/(?:.*)en\/(.*)/)[1];
// map the navigation object to a Docuaurus sidebar format
const sidebarItems = (navigation === null || navigation === void 0 ? void 0 : navigation.children)
? navigation.children.map((navigationItem) => {
if (navigationItem.isLabel) {
const sidebarCategoryItems = navigationItem.children
? navigationItem.children.map((navItem) => {
const url = this.getUrlKey(out, navItem.url);
if (navItem.children && navItem.children.length > 0) {
const sidebarCategoryChildren = navItem.children.map((childGroup) => this.getSidebarCategory(childGroup.title, childGroup.children
? childGroup.children.map((childItem) => this.getUrlKey(out, childItem.url))
: []));
return this.getSidebarCategory(navItem.title, [
url,
...sidebarCategoryChildren,
]);
}
return url;
})
: [];
return this.getSidebarCategory(navigationItem.title, sidebarCategoryItems);
}
return this.getUrlKey(out, navigationItem.url);
})
: [];
const sidebarPath = this.sidebar.sidebarPath;
external_fs_.writeFileSync(sidebarPath, JSON.stringify(sidebarItems, null, 2));
// @ts-ignore
this.application.logger.success(`TypeDoc sidebar written to ${sidebarPath}`);
}
/**
* returns a sidebar category node
*/
getSidebarCategory(title, items) {
return {
items,
type: 'category',
label: title,
};
}
/**
* returns the url key for relevant doc
*/
getUrlKey(out, url) {
const urlKey = url.replace('.md', '');
return out ? out + '/' + urlKey : urlKey;
}
};
sidebar_decorate([
(0,external_typedoc_namespaceObject.BindOption)('sidebar')
], SidebarComponent.prototype, "sidebar", void 0);
sidebar_decorate([
(0,external_typedoc_namespaceObject.BindOption)('siteDir')
], SidebarComponent.prototype, "siteDir", void 0);
sidebar_decorate([
(0,external_typedoc_namespaceObject.BindOption)('out')
], SidebarComponent.prototype, "out", void 0);
SidebarComponent = sidebar_decorate([
(0,components.Component)({ name: 'sidebar' })
], SidebarComponent);
/**
* Write content to sidebar file
*/
const writeSidebar = (sidebar, content) => {
if (!fs.existsSync(path.dirname(sidebar.sidebarPath))) {
fs.mkdirSync(path.dirname(sidebar.sidebarPath));
}
fs.writeFileSync(sidebar.sidebarPath, content);
};
;// CONCATENATED MODULE: ./src/plugin.ts
// @ts-ignore
@@ -830,7 +729,6 @@ const writeSidebar = (sidebar, content) => {
async function generate(siteDir, opts) {
// we need to generate an empty sidebar up-front so it can be resolved from sidebars.js
const options = getOptions(siteDir, opts);
@@ -850,9 +748,6 @@ async function generate(siteDir, opts) {
// add frontmatter component to typedoc renderer
// @ts-ignore
app.renderer.addComponent('fm', new FrontMatterComponent(app.renderer));
// add sidebar component to typedoc renderer
// @ts-ignore
app.renderer.addComponent('sidebar', new SidebarComponent(app.renderer));
// return the generated reflections
const project = app.convert();
// if project is undefined typedoc has a problem - error logging will be supplied by typedoc.
@@ -1011,14 +906,13 @@ if (process.env.DEV) {
try {
// Where your docs live, should be the folder containing the crates docs
const originPath = core.getInput("originPath"); // e.g. "/path/to/project/src/";
const sidebarFile = core.getInput("sidebarFile");
// Where you'll save your MD files
const targetPath = core.getInput("targetPath"); // e.g. "/path/to/docusaurus/website/docs/api/js/";
const docusaurusPath = core.getInput("docusaurusPath");
const overrideCondition = (request) => request.startsWith("typedoc");
const resolveRequest = (request) => require(path.normalize(process.cwd().replace("/dist/typedocusaurus", "") + `/${originPath}node_modules/${request}`));
overrideRequire(overrideCondition, resolveRequest);
const { default: generate } = __nccwpck_require__(879);
const { default: generate } = __nccwpck_require__(895);
await rmdir(targetPath, { recursive: true });
await generate(docusaurusPath, {
entryPoints: originPath + "src",
@@ -1028,9 +922,6 @@ if (process.env.DEV) {
hideBreadcrumbs: true,
watch: false,
tsconfig: originPath + "tsconfig.json",
sidebar: {
sidebarFile,
},
readme: "none",
});
console.log("Tasks completed!");

4
src/index.ts
View File

@@ -15,7 +15,6 @@ if (process.env.DEV) {
// Where your docs live, should be the folder containing the crates docs
const originPath = core.getInput("originPath"); // e.g. "/path/to/project/src/";
const sidebarFile = core.getInput("sidebarFile");
// Where you'll save your MD files
const targetPath = core.getInput("targetPath"); // e.g. "/path/to/docusaurus/website/docs/api/js/";
const docusaurusPath = core.getInput("docusaurusPath");
@@ -41,9 +40,6 @@ if (process.env.DEV) {
hideBreadcrumbs: true,
watch: false,
tsconfig: originPath + "tsconfig.json",
sidebar: {
sidebarFile,
},
readme: "none",
});

5
src/plugin.ts
View File

@@ -6,7 +6,6 @@ import { load } from 'typedoc-plugin-markdown';
import { FrontMatterComponent } from './front-matter';
import { addOptions, getOptions } from './options';
import { render } from './render';
import { SidebarComponent } from './sidebar';
import { PluginOptions } from './types';
@@ -39,10 +38,6 @@ export default async function generate(
// @ts-ignore
app.renderer.addComponent('fm', new FrontMatterComponent(app.renderer));
// add sidebar component to typedoc renderer
// @ts-ignore
app.renderer.addComponent('sidebar', new SidebarComponent(app.renderer));
// return the generated reflections
const project = app.convert();