TODO
This project aims to generate a Markdown documentation from a Table Schema JSON file.
Several attempts have been done:
- https://git.opendatafrance.net/validata/validata-doc-generator
- https://github.com/CharlesNepote/csv-schema-documentor
- https://github.com/AntoineAugusti/table-schema-to-markdown
Starting from discussions about strengths and weaknesses of each of them, here is a list of the needs:
- Be generic (not tied to the Validata project)
- Allow multiple outputs for fields doc generation: titles, table
- Allow custom content (i.e. before and after fields doc paragraph)
- Customize rendering (including i18n)
- Be usable without configuration
- Distribute it via https://pypi.org/
Technically, it implies:
- Using templates to generate Markdown
- A main template can include other ones: templates for fields doc and templates for the whole page can co-exist
- Templates can be bundled with the project (like fields doc with titles and table), others can be maintained and called by the user
- i18n can be achieved via templates
- Validata-specific text can be set via templates
Which template language?