/**
* Auxiliary module to provide code api documentation.
*
*
* Once 'backend' data has been generated, customization of the output is using a layer running in the
* browser. For now, the customization is essentially defined using css through the {@link Configuration.css} attribute.
* Its purpose is to link {@link Semantic.role} attribute to display options.
*
* For instance,
* this
* is the default css file of the {@link configurationTsTypedoc}.
*
* @module CodeApi
*/
export * from './attribute.view';
export * from './type.view';
export * from './code.view';
export * from './configurations';
export * from './documentation.view';
export * from './models';
export * from './module.view';
export * from './utils';
import { Observable } from 'rxjs';
import { ModuleView } from './module.view';
import { AnyVirtualDOM } from '@youwol/rx-vdom';
import { Configuration } from './configurations';
import { Module, Project } from './models';
import type { Decoration, Navigation, Router, Views } from '../index';
import type { installNotebookModule } from '../../index';
import type { parseMd } from '../markdown';
export declare class Dependencies {
static parseMd: typeof parseMd;
static Views: typeof Views;
static installNotebookModule: typeof installNotebookModule;
static headingPrefixId: string;
}
export declare const tocConvertor: (heading: HTMLHeadingElement) => AnyVirtualDOM;
export declare function fetchModuleDoc({ modulePath, basePath, configuration, project, }: {
modulePath: string;
basePath: string;
configuration: Configuration;
project: Project;
}): Observable;
export declare const docNode: ({ project, configuration, }: {
project: Project;
configuration: Configuration;
}) => Navigation;
export declare const docNavigation: ({ modulePath, router, project, configuration, }: {
modulePath: string;
router: Router;
project: Project;
configuration: Configuration;
}) => Observable<{
children: {
name: string;
leaf: boolean;
id: string;
decoration: {
icon: {
tag: "i";
class: string;
};
};
}[];
html: () => ModuleView;
tableOfContent: (d: {
html: HTMLElement;
router: Router;
}) => Promise;
}>;
export declare function codeApiEntryNode(params: {
name: string;
decoration: Decoration;
docBasePath: string;
entryModule: string;
configuration: Configuration;
}): {
name: string;
decoration: Decoration;
html: ({ router }: {
router: any;
}) => Observable;
tableOfContent: typeof Views.tocView;
'...': ({ router, path }: {
router: any;
path: any;
}) => Observable<{
children: {
name: string;
leaf: boolean;
id: string;
decoration: {
icon: {
tag: "i";
class: string;
};
};
}[];
html: () => ModuleView;
tableOfContent: (d: {
html: HTMLElement;
router: Router;
}) => Promise;
}>;
};