yosefserkez/Generate content map
Generate a map of all content found in the site directory
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| file_types | file types to include in the index. | yes | md |
| meta_key | only include pages with a given key in the metadata (currently only one supported) | no | "" |
| meta_value | only include pages with a given value matching the provided key in the metadata (requires meta_key to be set, and only one supported) | no | "" |
| exclude_paths | paths to exclude from being indexed (ie: node_modules) | no | "" |
| output_file | name and location for the json file for output. defaults to "./site_content_map". Set to empty to skip saving file (maybe you only want to pass it to another action) | yes | site_content_map |
| website_root | root path to the website used when setting a path to the original file | no | "" |
| output_content_type | type of content to return in output if desired. Options are markdown or html. defaults to markdown. | yes | markdown |
| output_content_max_length | If set will trim the output content to a maximum length. Useful for generating excerpts rather. | no | All content |
Outputs
| name | description |
|---|---|
| contents | A json object containing the each indexed page with the content and metadata. |