metadata/keys.md
Meta data keys
A File may have YAML meta data within a comment at the top of the file. This allows introspection when using the components through the theatre app.
| name | description |
|---|---|
| files | a list of assocated files. Usually relative to the src directory |
| title | A title for the js (theatre) file |
| doc_readme | A filepath reference to the associated doc. Relative to the doc directory |
| doc_content | a list of regex paths to reference all the content files. e.g. point/*.md. |
| doc_imports | Similar to the files, a list of imports used when this file is in the documentation page. Useful for the auto parsing. |
Info
keys: dict_keys(['exists', 'path', 'text', 'meta', 'rendered'])
path: metadata/keys.md
exists: True
meta: dict_keys(['filepath_exists', 'path', 'filepath', 'markdown'])