---
title: "Docs Generator"
description: "generate documentation files"
source: "https://github.com/log-10x/modules/tree/main/pipelines/doc/units/generate/unit.yaml"
icon: "material/language-markdown"

---
Pipeline markdown documentation generator.

## :material-menu: Options

Specify the options below to [configure](/config "configure") the Docs generator:

|Name|Description|
|---|---|
|[docGenerate](#docgenerate "load markdown files")|Load markdown files|
|[docConfigRepoName](#docconfigreponame "config repo name")|Config repo name|
|[docConfigRepoBranch](#docconfigrepobranch "config branch name")|Config branch name|
|[docModulesRepoName](#docmodulesreponame "modules repo name")|Modules repo name|
|[docModulesRepoBranch](#docmodulesrepobranch "modules branch name")|Modules branch name|
|[docModulesInputPath](#docmodulesinputpath "folder to scan for pipeline modules")|Folder to scan for pipeline modules|
|[docAppsInputPath](#docappsinputpath "folder to scan for app modules")|Folder to scan for app modules|
|[docConfigInputPath](#docconfiginputpath "folder to scan for pipeline modules")|Folder to scan for pipeline modules|
|[docSiteOutputPath](#docsiteoutputpath "site folder to output markdown to")|Site folder to output markdown to|
|[docApiFile](#docapifile "path to js api md")|Path to js api md|
|[docGithubAPIKey](#docgithubapikey "GitHub api key")|GitHub api key|

### :material-menu-right-outline:**`docGenerate`**

Load markdown files.

|Type|Required|
|---|---|
|Boolean|✔|

Load pipeline markdown (.md) 'doc' file setting for which to generate docs.


### :material-menu-right-outline:**`docConfigRepoName`**

Config repo name.

|Type|Required|
|---|---|
|String|✔|

Name of config github repository to link for pipeline configuration.


### :material-menu-right-outline:**`docConfigRepoBranch`**

Config branch name.

|Type|Required|
|---|---|
|String|✔|

Name of branch in config github repository to link for pipeline configuration.


### :material-menu-right-outline:**`docModulesRepoName`**

Modules repo name.

|Type|Required|
|---|---|
|String|✔|

Name of modules github repository to link for pipeline modules.


### :material-menu-right-outline:**`docModulesRepoBranch`**

Modules branch name.

|Type|Required|
|---|---|
|String|✔|

Name of branch in modules github repository to link for pipeline configuration.


### :material-menu-right-outline:**`docModulesInputPath`**

Folder to scan for pipeline modules.

|Type|Required|
|---|---|
|String|✔|

Folder to scan for pipeline units and modules to generate markdown docs for.


### :material-menu-right-outline:**`docAppsInputPath`**

Folder to scan for app modules.

|Type|Required|
|---|---|
|String|✔|

Folder to scan for app modules to generate markdown docs for.


### :material-menu-right-outline:**`docConfigInputPath`**

Folder to scan for pipeline modules.

|Type|Required|
|---|---|
|String|✔|

Folder to scan for pipeline unit and module config files to generate markdown docs for.


### :material-menu-right-outline:**`docSiteOutputPath`**

Site folder to output markdown to.

|Type|Required|
|---|---|
|String|✔|

Folder to write for pipeline components markdown docs to.


### :material-menu-right-outline:**`docApiFile`**

Path to js api md.

|Type|Required|
|---|---|
|String|✔|

Path to js api md.


### :material-menu-right-outline:**`docGithubAPIKey`**

GitHub api key.

|Type|Default|
|---|---|
|String|""|

For validating GitHub links.


<br/>:material-github: This unit is defined in [generate/unit.yaml](https://github.com/log-10x/modules/tree/main/pipelines/doc/units/generate/unit.yaml "generate/unit.yaml"){target="\_blank"}.