erikyo/TSDoc Action
GitHub Action to build TSDoc documentation
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| source_dir | Source directory to build documentation from | no | — |
| output_dir | Output folder for the generated documentation | no | — |
| tsconfig_file | The path to a tsconfig.json file. Defaults to ./tsconfig.json | no | — |
| options | Options to be forwarded to Typedoc when generating documentation | no | — |
| theme | The TSDoc template or theme to install. https://typedoc.org/guides/themes/ | no | — |
| themeColor | The color of the theme | no | — |
| plugin | a typedoc plugin to be used (see install instructions) | no | — |
| install_module | the name of the module to install (use it to install a plugin for example) | no | — |
| logLevel | The log level to use [Verbose|Debug|Info|Warn|Error|None] | no | — |
| showConfig | Print TypeDoc config and exit. Useful for debugging what options have been set. | no | — |
| skipErrorChecking | Instructs TypeDoc to not run the type checker before converting a project. Enabling this option may improve generation time, but could also result in crashes if your code contains type errors. | no | — |
| excludeExternals | Prevent externally resolved TypeScript files from being documented. Defaults to false. | no | — |
| template_name | This input variable is deprecated in favour of "template" | no | — |
| front_page | The path to a Markdown file to be used as the front page | no | — |
| lightHighlightTheme | The Shiki theme to be used to highlight code snippets in light mode | no | — |
| darkHighlightTheme | The Shiki theme to be used to highlight code snippets in dark mode | no | — |
| customCss | Extra CSS file to be copied into the assets directory and referenced by the theme | no | — |
| markedOptions | Options to be forwarded to Marked when parsing doc comments | no | — |
| basePath | Base path to be used when displaying file paths | no | — |
| cname | Text for creating a CNAME file in the output directory | no | — |
| sourceLinkExternal | Treat source links as external links that open in a new tab when generating HTML | no | — |
| htmlLang | Sets the lang attribute in TypeDocs HTML output | no | — |
| githubPages | Automatically add a .nojekyll file to the output directory to prevent GitHub Pages from processing your documentation site using Jekyll | no | — |
| cacheBust | Include the generation time in <script> and <link> tags to JS/CSS assets to prevent assets from a previous build of the documentation from being used | no | — |
| gaID | Set the Google Analytics tracking ID and activate tracking code | no | — |
| hideParameterTypesInTitle | Hide parameter types in the signature "title" for easier scanning | no | — |
| hideGenerator | Do not print the TypeDoc link at the end of the page | no | — |
| searchInComments | Enables searching comment text in the generated documentation site | no | — |
| cleanOutputDir | Prevent TypeDoc from cleaning the output directory specified with --out | no | — |
| titleLink | Link the title in the header points to | no | — |
| navigationLinks | Additional links to be included in the page header | no | — |
| sidebarLinks | Additional links to be included in the page sidebar | no | — |
| navigation | Configuration for determining if groups/categories will be included in the primary navigation pane | no | — |
| categorizeByGroup | Affects if groups/categories will be included in the primary navigation pane | no | — |
| navigationLeaves | Specifies namespaces/modules which should not be expandable in the navigation tree | no | — |
| visibilityFilters | Specifies the available filters when viewing a page | no | — |
| searchCategoryBoosts | Configure the search to increase the relevance of items in a given category | no | — |
| searchGroupBoosts | Configure the search to increase the relevance of items in a given group | no | — |
Outputs
no outputs