@ui-js/grok
Advanced tools
A tool to build beautiful documentation from TypeScript declaration files
grok: /grok/, /grohk/, vt.
To understand. Connotes intimate and exhaustive knowledge.
Grok turns a TypeScript declaration file into a beautiful, readable, web page.
npm install --global @ui-js/grok
# Create documentation for the .d.ts files in ./dist into the ./docs folder
grok ./dist --outDir docs
Configuration can be specified:
grok property in package.jsongrok.config.json, grok.config.yaml, grok.config.js file in your
project--config CLI option. In that case, the
config file will be used in addition to other configuration files that may
be present (it doesn't replace them)The configuration can include the following keys:
sdkName The name of the SDK being documented
exclude An array of glob patterns to skip documenting, e.g. '**/*.test.ts'
cssVariables A dictionary of variables and their associated value which will
be attached to the <body> tag.
tutorialPath Prefix added to the value of a {@tutorial} tag to determine
the URL to redirected to.
For example, {@tutorial readme.html} with
tutorialPath = 'https://example.com/docs' will redirect to
'https://example.com/docs/readme.html'
externalReferences: Set of symbols that have an external reference other
than the standard one (MDN).
Can be used for global symbols, or symbols referenced cross-module.
modules An array of module names that will be documented. This is useful
both to indicate the order in which the modules should be displayed in the
documentation and to 'hide' any unnecessary modules, while still preserving
their visibility to the parser.
documentTemplate A string or function which will be used to build the output
file. If a string, the following substitutions will be applied:
{{content}} HTML markup of the documentation (suitable for as the content
of a <body> tag){{sdkName}} The name of the SDK, as indicated above{{packageName}}{{moduleName}} The name of the module being documented, if there is a
single one{{className}} The name of the first class being documented{{directoryName}} The name of the directory being documentedIf a function, the function is passed an object literal with the following
properties: content, sdkName, packageName and cssVariables which is
the dictionary specified in the options.
Grok supports the standard tags defined by tsdoc.
The {@link symbol} and its variants can use the tsdoc
standard declaration references
to disambiguate which symbol to point to.
Grok supports a few additional extensions, including:
{@linkcode symbol} and [[`symbol` | title]] to create a link to a
symbold displayed as code (in monospace font)[[symbol]] a synonym for {@link symbol}@keywords followed by a comma separated list of words which can be used by
the search boxexport type InlineShortcutsOptions = {
/** @deprecated Use:
* ```typescript
* mf.setConfig(
* 'inlineShortcuts',
* { ...mf.getConfig('inlineShortcuts'),
* ...newShortcuts
* }
* )
* ```
* to add `newShortcuts` to the default ones. See {@linkcode setConfig} */
overrideDefaultInlineShortcuts?: boolean;
};
/**
* Converts a LaTeX string to an Abstract Syntax Tree (MathJSON)
*
* **See:** {@tutorial MATHJSON | MathJson}
*
* @param latex A string of valid LaTeX. It does not have to start
* with a mode token such as a `$$` or `\(`.
* @param options.macros A dictionary of LaTeX macros
*
* @return The Abstract Syntax Tree as an object literal using the MathJSON format.
* @category Converting
* @keywords convert, latex, mathjson, ast
*/
export declare function latexToAST(
latex: string,
options?: {
macros?: MacroDictionary;
}
);
FAQs
A tool to build beautiful documentation from TypeScript declaration files
The npm package @ui-js/grok receives a total of 33 weekly downloads. As such, @ui-js/grok popularity was classified as not popular.
We found that @ui-js/grok demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.