() => IApi<void>
Returns a new instance of Documentalist with no plugins.
+() => IApi<{}>Returns a new instance of Documentalist with no plugins.
Documentalist uses a plugin architecture to support arbitrary file types.
-Copyright 2017-present Palantir Technologies, Inc. All rights reserved.
+Licensed under the BSD-3 License as modified (the “License”); you may obtain
+a copy of the license in the LICENSE and PATENTS files in the root of this
+repository.
+Represents a single @tag <value> line from a file.
| clearPlugins | +tag |
- () => IApi<void> Returns a new instance of Documentalist with no plugins. - +string |
| documentFiles | +value |
- (files: IFile[]) => any Iterates over all plugins, passing all matching files to each in turn. -The output of each plugin is merged to produce the resulting -documentation object. -The return type T is a composite type has a composite type of all the -plugin data types. - +string |
| documentGlobs | -
- (...filesGlobs: string[]) => any Finds all files matching the provided variadic glob expressions and then
-runs |
Metadata is parsed from YAML front matter in files and can contain arbitrary data. +A few keys are understood by Documentalist and, if defined in front matter, +will override default behavior.
+---
+reference: overview
+title: "Welcome to the Jungle"
+---
+actual contents of file...
+| renderBlock | +reference |
- (blockContent: string, reservedTagWords?: string[]) => IBlock Render a block of content by extracting metadata (YAML front matter) and
-splitting text content into markdown-rendered HTML strings and To prevent special strings like "@include" from being parsed, a reserved -tag words array may be provided, in which case the line will be left as -is. +string Unique ID for addressing this page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| use | +title |
- <P>(pattern: string | RegExp, plugin: IPlugin<P>) => IApi<T & P> Adds the plugin to Documentalist. Returns a new instance of Documentalist
-with a template type that includes the data from the plugin. This way the
- The plugin is applied to all files whose absolute path matches the -supplied pattern. +string Human-friendly title of this page, for display in the UI.#` tag |
| content | +absolutePath |
- string The original string content block. +string Absolute path of source file. |
| metadata | +contentRaw |
- any Parsed YAML front matter (if any) or {}. +string Raw unmodified contents of source file (excluding the metadata). |
| renderedContent | +contents |
- StringOrTag[] An array of markdown-rendered HTML or tags. +StringOrTag[] Parsed nodes of source file. An array of rendered HTML strings or |
| filePath | +metadata |
- string+ IMetadata Arbitrary YAML metadata parsed from front matter of source file + |
| rules | +reference |
- IRule[]+ string Unique identifier for addressing this page. + + |
+
| title | +
+ string Human-friendly title of this page. + |
One page entry in a layout tree.
+| filePath | +depth | +
+ number+ |
+
| reference |
string |
|
| rules | +title |
- IRule[]+ string |
A page has ordered children composed of @#+ and @page tags.
| css | +children |
- ICss[]+ (IPageNode | IHeadingNode)[] |
An @#+ tag belongs to a specific page.
| prop | +path |
string |
| value | +read |
- string+ () => string+ |
+
| compile | +
+ (doc: Documentalist<T>, files: IFile[]) => any |
| documentation | +comment |
- IBlock+ StringOrTag[] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fileName | +commentRaw |
string |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | +declarations |
- string+ IDeclaration[] |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tags | +metadata |
- IJsDocTags+ any |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | +selector |
string |
@@ -366,381 +397,320 @@
| path | +filePath |
string |
| read | +rules |
- () => string+ IRule[] |
An @#+ tag belongs to a specific page.
| css | +
+ ICss[]+ |
+
| extends | +documentation |
- string[]+ string |
| properties | +markup |
- IPropertyEntry[]+ string+ |
+
| reference | +
+ string |
| css | +modifiers |
- ICss[]+ IKssEntry[] |
| docs | +css |
- IPageMap+ { [name: string]: IKssExample; }
|
Metadata is parsed from YAML front matter in files and can contain arbitrary data. -A few keys are understood by Documentalist and, if defined in front matter, -will override default behavior.
----
-reference: overview
-title: "Welcome to the Jungle"
----
-actual contents of file...
-| reference | -
- string Unique ID for addressing this page. - - |
-
| title | -
- string Human-friendly title of this page, for display in the UI.#` tag - - |
-
A single Documentalist page, parsed from a single source file.
- +| absolutePath | -
- string Absolute path of source file. - - |
- |
| contentRaw | +docs |
- string Raw unmodified contents of source file (excluding the metadata). - +IPageMap |
| contents | +documentation |
- StringOrTag[] Parsed nodes of source file. An array of rendered HTML strings or IBlock |
| metadata | +fileName |
- IMetadata Arbitrary YAML metadata parsed from front matter of source file - +string |
| reference | +name |
- string Unique identifier for addressing this page. - +string |
| title | +tags |
- string Human-friendly title of this page. - +IJsDocTags |
A page has ordered children composed of @#+ and @page tags.
| children | +type |
- (IPageNode | IHeadingNode)[]+ string |
| compile | +optional |
- (doc: Documentalist<T>, files: IFile[]) => any+ boolean |
Plugins are stored with the regex used to match against file paths.
- +| pattern | +extends |
- RegExp+ string[] |
| plugin | +properties |
- IPlugin<T>+ IPropertyEntry[] |
| optional | +ts |
- boolean+ { [name: string]: IInterfaceEntry; }
|
| comment | +clearPlugins |
- StringOrTag[]+ () => IApi<{}>Returns a new instance of Documentalist with no plugins. + |
| commentRaw | +documentFiles |
- string+ (files: IFile[]) => any Iterates over all plugins, passing all matching files to each in turn. +The output of each plugin is merged to produce the resulting +documentation object. +The return type T is a composite type has a composite type of all the +plugin data types. + |
| declarations | +documentGlobs |
- IDeclaration[]+ (...filesGlobs: string[]) => any Finds all files matching the provided variadic glob expressions and then
+runs |
| metadata | +renderBlock |
- any+ (blockContent: string, reservedTagWords?: string[]) => IBlock Render a block of content by extracting metadata (YAML front matter) and
+splitting text content into markdown-rendered HTML strings and To prevent special strings like "@include" from being parsed, a reserved +tag words array may be provided, in which case the line will be left as +is. + |
| selector | +use |
- string+ <P>(pattern: string | RegExp, plugin: IPlugin<P>) => IApi<T & P> Adds the plugin to Documentalist. Returns a new instance of Documentalist
+with a template type that includes the data from the plugin. This way the
+ The plugin is applied to all files whose absolute path matches the +supplied pattern. + |
The output of renderBlock which parses a long form documentation block into
+metadata, rendered markdown, and tags.
| comment | -
- StringOrTag[]- |
- |
| commentRaw | -
- string- |
- |
| declarations | +content |
- IDeclaration[]+ string The original string content block. + |
| metadata |
- any- |
- |
| selector | -
- string- |
-
Copyright 2017-present Palantir Technologies, Inc. All rights reserved.
-Licensed under the BSD-3 License as modified (the “License”); you may obtain
-a copy of the license in the LICENSE and PATENTS files in the root of this
-repository.
-Represents a single @tag <value> line from a file.
any
Parsed YAML front matter (if any) or {}.
-| tag | -
- string |
|
| value | +renderedContent |
- string+ StringOrTag[] An array of markdown-rendered HTML or tags. + |
One page entry in a layout tree.
+Plugins are stored with the regex used to match against file paths.
| depth | -
- number- |
- |
| reference | -
- string- |
- |
| title | +pattern |
- string+ RegExp |
| ts | +plugin |
- IInterfaceEntry[]+ IPlugin<T> |