DirectoryPreparer
Home > @backstage/plugin-techdocs-node > DirectoryPreparer
Preparer used to retrieve documentation files from a local directory
Signature:
class DirectoryPreparer implements PreparerBase
Implements: PreparerBase
Methods
| Method | Modifiers | Description |
|---|---|---|
| fromConfig(config, options) | static | Returns a directory preparer instance |
| prepare(entity, options) | Given an Entity definition from the Software Catalog, go and prepare a directory with contents from the location in temporary storage and return the path. | |
| shouldCleanPreparedDirectory() | Indicates whether the prepared directory should be cleaned after generation. |