A package to help us generate tymly-docs as Markdown files
Tymly-doc-generator (with the aid of the Tymly-gatherer package) generates a series of Markdown files that describe the contents of any Tymly shaped repo
$ npm install @wmfs/tymly-doc-generator
- If a
TYMLY_MONOREPO_PATH environment variable is set, then the generation tests will generate locally.
TYMLY_MONOREPO_PATH isn't set, then only Standard.js tests will be performed.
|MANDATORY: Where the root
tymly dir can be found (inside this should be the
packages etc. dirs). So something like C:/development/tymly`.
|Optional: Supply if you want to see what's going on, e.g.
docs dir is going to be written (note the
docs dir itself will be written). So to target the tymly-website project, you should set it to something like
C:/development/tymly-website. NOTE: Some sub-directories (e.g.
/docs/reference) will be deleted on generation, so make sure to get this one right! :smiley:
|Optional: Only supplying
true will change behaviour. If you do this then the gathering phase will be omitted (relying instead on a previously-generated
$TYMLY_DOCS_OUTPUT_PATH/gathered-info.json file... so you'll need to have generated with no skipping at least once before trying this).
With the environment variables set...
npm run generate
$ npm run test