CompilerInterfacesIBlockICompilerICompilerOptionsIFileIHeadingNodeIHeadingTagIKssExampleIKssModifierIKssPluginDataIMarkdownPluginDataIMarkdownPluginOptionsIMetadataINavigableINpmPackageINpmPluginDataINpmPluginOptionsIPageDataIPageNodeIPluginIPluginEntryITagITsCallableITsClassITsConstructorITsDefaultValueITsDocBaseITsEnumITsEnumMemberITsFlagsITsInterfaceITsMethodITsObjectDefinitionITsParameterITsPropertyITsSignatureITsTypeAliasITypescriptPluginDataITypescriptPluginOptions
Kind
StringOrTag
- -+
class Documentalist #
class Documentalist #Constructor
@@ -152,7 +152,7 @@
Plugins
-
interface IPlugin #A Documentalist plugin is an object with a
compile(files, compiler)function +
interface IPlugin #A Documentalist plugin is an object with a
compile(files, compiler)function that returns a data object (or a promise for that object).A common pattern is to define a class that implements this interface and use the constructor to accept options.
@@ -203,7 +203,7 @@License
+
class Compiler implements ICompiler #
class Compiler implements ICompiler #Constructor
@@ -258,7 +258,7 @@
Methods
+
class Documentalist #
class Documentalist #Constructor
@@ -337,7 +337,7 @@
Methods
+
class PageMap #
class PageMap #Methods
@@ -401,7 +401,7 @@
Methods
class MarkdownPlugin implements IPlugin<IMarkdownPluginData> #The
MarkdownPluginparses and renders markdown pages and produces a navigation tree of all documents. +
class MarkdownPlugin implements IPlugin<IMarkdownPluginData> #The
@@ -443,7 +443,7 @@MarkdownPluginparses and renders markdown pages and produces a navigation tree of all documents. This plugin traces@pageand@#+"heading" tags to discover pages (given a single startingnavPage) and build up a tree representation of those pages.Methods
class NpmPlugin implements IPlugin<INpmPluginData> #The
NpmPluginparsespackage.jsonfiles and emits data about each NPM +
class NpmPlugin implements IPlugin<INpmPluginData> #The
@@ -477,7 +477,7 @@NpmPluginparsespackage.jsonfiles and emits data about each NPM package. It usesnpm infoto look up data about published packages, and falls back topackage.jsoninfo if the package is private or unpublished.Methods
+
class Visitor #
class Visitor #Constructor
@@ -508,7 +508,7 @@
Methods
+
class TypescriptPlugin implements IPlugin<ITypescriptPluginData> #
class TypescriptPlugin implements IPlugin<ITypescriptPluginData> #Constructor
@@ -539,7 +539,7 @@
Methods
class KssPlugin implements IPlugin<IKssPluginData> #The
KssPluginextracts KSS doc comments from CSS code (or similar languages). +
class KssPlugin implements IPlugin<IKssPluginData> #The
@@ -576,7 +576,7 @@KssPluginextracts KSS doc comments from CSS code (or similar languages). It emits an object keyed by the "styleguide [ref]" section of the comment. The documentation, markup, and modifiers sections will all be emitted in the data.Methods
enum Kind #Enumeration describing the various kinds of member supported by this plugin.
+
enum Kind #Enumeration describing the various kinds of member supported by this plugin.
Members
@@ -667,7 +667,7 @@Members
interface ITsCallable #Common type for a callable member, something that can be invoked.
+
interface ITsCallable #Common type for a callable member, something that can be invoked.
see:
@@ -702,7 +702,7 @@ITsConstructorProperties
interface ITag #Represents a single
+@tag <value>line from a file.
interface ITag #Represents a single
@tag <value>line from a file.Properties
@@ -731,7 +731,7 @@Properties
interface IHeadingTag extends ITag, INavigable #Represents a single
@#+ <value>heading tag from a file. Note that all@#+tags +
interface IHeadingTag extends ITag, INavigable #Represents a single
@#+ <value>heading tag from a file. Note that all@#+tags (@#through@######) are emitted astag: "heading"so only one renderer is necessary to capture all six levels.Heading tags include additional information over regular tags: fully-qualified
routeof the @@ -781,7 +781,7 @@Properties
interface ICompiler #Each plugin receives a
+Compilerinstance to aid in the processing of source files.
interface ICompiler #Each plugin receives a
Compilerinstance to aid in the processing of source files.Methods
@@ -834,7 +834,7 @@Methods
interface IMetadata #Metadata is parsed from YAML front matter in files and can contain arbitrary data. +
interface IMetadata #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.
--- @@ -871,7 +871,7 @@Properties
interface IBlock #The output of
renderBlockwhich parses a long form documentation block into +
interface IBlock #The output of
renderBlockwhich parses a long form documentation block into metadata, rendered markdown, and tags.Properties
@@ -910,7 +910,7 @@Properties
interface IKssModifier #A single modifier for an example.
+
interface IKssModifier #A single modifier for an example.
Properties
@@ -937,7 +937,7 @@Properties
interface IKssExample #A markup/modifiers example parsed from a KSS comment block.
+
interface IKssExample #A markup/modifiers example parsed from a KSS comment block.
Properties
@@ -995,7 +995,7 @@Properties
interface IKssPluginData #The
+KssPluginexports acsskey that contains a map of styleguide references to markup/modifier examples.
interface IKssPluginData #The
KssPluginexports acsskey that contains a map of styleguide references to markup/modifier examples.see:
@@ -1017,7 +1017,7 @@KSSPluginProperties
interface IMarkdownPluginData #The
MarkdownPluginexports a map of markdownpageskeyed by reference, +
interface IMarkdownPluginData #The
MarkdownPluginexports a map of markdownpageskeyed by reference, and a multi-rootednavtree of page nodes.Properties
@@ -1049,7 +1049,7 @@Properties
interface IPageData extends IBlock #A single Documentalist page, parsed from a single source file.
+
interface IPageData extends IBlock #A single Documentalist page, parsed from a single source file.
Properties
@@ -1123,7 +1123,7 @@Properties
interface IHeadingNode extends INavigable #An
+@#+tag belongs to a specific page.
interface IHeadingNode extends INavigable #An
@#+tag belongs to a specific page.Properties
@@ -1161,7 +1161,7 @@Properties
interface IPageNode extends IHeadingNode #A page has ordered children composed of
+@#+and@pagetags.
interface IPageNode extends IHeadingNode #A page has ordered children composed of
@#+and@pagetags.Properties
@@ -1217,7 +1217,7 @@Properties
interface INpmPackage #Copyright 2018-present Palantir Technologies, Inc. All rights reserved. +
interface INpmPackage #Copyright 2018-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.
@@ -1312,7 +1312,7 @@Properties
interface INpmPluginData #The
+KssPluginexports acsskey that contains a map of styleguide references to markup/modifier examples.
interface INpmPluginData #The
KssPluginexports acsskey that contains a map of styleguide references to markup/modifier examples.see:
@@ -1334,7 +1334,7 @@KSSPluginProperties
interface IPlugin #A Documentalist plugin is an object with a
compile(files, compiler)function +
interface IPlugin #A Documentalist plugin is an object with a
compile(files, compiler)function that returns a data object (or a promise for that object).A common pattern is to define a class that implements this interface and use the constructor to accept options.
@@ -1374,7 +1374,7 @@Methods
interface IFile #Abstract representation of a file, containing absolute path and synchronous
readoperation. +
interface IFile #Abstract representation of a file, containing absolute path and synchronous
readoperation. This allows plugins to use only the path of a file without reading it.Properties
@@ -1407,7 +1407,7 @@Methods