Skip to content

Commit

Permalink
add a how to on testing locally
Browse files Browse the repository at this point in the history
  • Loading branch information
Blargian committed Nov 16, 2024
1 parent f4c7584 commit aa50fc3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions scripts/settings/autogenerated-markdown-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,11 @@ Where:

If different row formatting is needed for a specific markdown file, then please create a new `row_setttings_{page}.format` and specify to use this new file with the `format_template_row` setting in the query.

## Testing locally

(Assuming you can already build the docs locally. (If not see the docs repository readme for details))
To test locally you can run `yarn new-build` (see package.json for details) to build the docs. Afterwards run `yarn start` to launch docusaurus locally.
You can inspect the pages to make sure that the output is correct.

N.B Any changes to the content of the descriptions of the settings now need to be made to the table itself.
changes made to the generated markdown files will just be overwritten each time we build the documentation.

0 comments on commit aa50fc3

Please sign in to comment.