@unified-latex/unified-latex-util-to-string 1.0.0

package/README.md

@@ -0,0 +1,194 @@
+<!-- DO NOT MODIFY -->
+<!-- This file was autogenerated by build-docs.ts -->
+<!-- Edit the docstring in index.ts and regenerate -->
+<!-- rather than editing this file directly. -->
+# unified-latex-util-parse
+
+## What is this?
+
+Functions parse strings to a `unified-latex` Abstract Syntax Tree (AST).
+
+## When should I use this?
+
+If you have a string that you would like to parse to a `unified-latex` `Ast.Ast`, or
+if you are building a plugin for `unified()` that manipulates LaTeX.
+
+# Plugins
+
+## `unifiedLatexAstComplier`
+
+Unified complier plugin that passes through a LaTeX AST without modification.
+
+### Usage
+
+`unified().use(unifiedLatexAstComplier)`
+
+### Type
+
+`Plugin<void[], Ast.Root, Ast.Root>`
+
+```typescript
+function unifiedLatexAstComplier(): void;
+```
+
+## `unifiedLatexFromString`
+
+Parse a string to a LaTeX AST.
+
+### Usage
+
+`unified().use(unifiedLatexFromString[, options])`
+
+#### options
+
+```typescript
+{ mode?: "math" | "regular"; macros?: Ast.MacroInfoRecord; environments?: Ast.EnvInfoRecord; }
+```
+
+### Type
+
+`Plugin<{ mode?: "math" | "regular"; macros?: Ast.MacroInfoRecord; environments?: Ast.EnvInfoRecord; }[], string, Ast.Root>`
+
+```typescript
+function unifiedLatexFromString(options: {
+  mode?: "math" | "regular";
+  macros?: Ast.MacroInfoRecord;
+  environments?: Ast.EnvInfoRecord;
+}): void;
+```
+
+## `unifiedLatexFromStringMinimal`
+
+Parse a string to a LaTeX AST with no post processing. For example,
+no macro arguments will be attached, etc.
+
+### Usage
+
+`unified().use(unifiedLatexFromStringMinimal[, options])`
+
+#### options
+
+```typescript
+PluginOptions
+```
+
+### Type
+
+`Plugin<PluginOptions[], string, Ast.Root>`
+
+```typescript
+function unifiedLatexFromStringMinimal(options: PluginOptions): void;
+```
+
+## `unifiedLatexStringComplier`
+
+Unified complier plugin that prints a LaTeX AST as a string.
+
+### Usage
+
+`unified().use(unifiedLatexStringComplier[, options])`
+
+#### options
+
+```typescript
+{ pretty?: boolean; printWidth?: number; useTabs?: boolean; }
+```
+
+### Type
+
+`Plugin<{ pretty?: boolean; printWidth?: number; useTabs?: boolean; }[], Ast.Root, string>`
+
+```typescript
+function unifiedLatexStringComplier(options: {
+  pretty?: boolean;
+  printWidth?: number;
+  useTabs?: boolean;
+}): void;
+```
+
+# Functions
+
+## `parse(str)`
+
+Parse the string into an AST.
+
+```typescript
+function parse(str: String): Ast.Root;
+```
+
+**Parameters**
+
+| Param | Type     |
+| :---- | :------- |
+| str   | `String` |
+
+## `parseMath(str)`
+
+Parse `str` into an AST. Parsing starts in math mode and a list of
+nodes is returned (instead of a "root" node).
+
+```typescript
+function parseMath(str: string | Ast.Ast): Ast.Node[];
+```
+
+**Parameters**
+
+| Param | Type                |
+| :---- | :------------------ |
+| str   | `string \| Ast.Ast` |
+
+## `parseMathMinimal(str)`
+
+Parse `str` to an AST with minimal processing. E.g., macro
+arguments are not attached to macros, etc. when parsed with this
+function.
+
+The parsing assumes a math-mode context, so, for example, `^` and `_` are
+parsed as macros (even though arguments are not attached to them).
+
+```typescript
+function parseMathMinimal(str: String): Ast.Node[];
+```
+
+**Parameters**
+
+| Param | Type     |
+| :---- | :------- |
+| str   | `String` |
+
+## `parseMinimal(str)`
+
+Parse `str` to an AST with minimal processing. E.g., macro
+arguments are not attached to macros, etc. when parsed with this
+function.
+
+```typescript
+function parseMinimal(str: String): Ast.Root;
+```
+
+**Parameters**
+
+| Param | Type     |
+| :---- | :------- |
+| str   | `String` |
+
+# Constants
+
+| Name                          | Type                                        | Description                                                                                                                                   |
+| :---------------------------- | :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- |
+| `processLatexToAstViaUnified` | `() => Processor<Root, Root, Root, void>`   | Use `unified()` to a string to an `Ast.Ast` and then return it. This function&#xA;will not print/pretty-print the `Ast.Ast` back to a string. |
+| `processLatexViaUnified`      | `() => Processor<Root, Root, Root, string>` | Use `unified()` to a string to an `Ast.Ast` and then pretty-print it.                                                                         |
+
+# Types
+
+## `PluginOptions`
+
+```typescript
+export type PluginOptions =
+    | {
+          mode?: "math" | "regular";
+          macros?: MacroInfoRecord;
+          environments?: EnvInfoRecord;
+      }
+    | undefined;
+```