Design Decisions - alexvoss/torshi GitHub Wiki

Torshi should:

• be independent of any specific static site generator or other tooling: after a few other attempts, the one before this one was to implement it as a plugin for MkDocs so that it would work with Material for MkDocs. However, there is currently some uncertainty about the future of MkDocs, especially questions about any future plugin API. It also became apparent that it would be just as easy to write the tool as a preprocessor for input files as it merely replaces code blocks and other placeholders.

• support translating Gherkin files with embedded Markdown: given that Cucumber tooling is beginning to support this, it would seem odd if Torshi did not.

• not add significant processing delays: given that the resulting Markdown has to be picked up and processed by another tool, Torshi should work as swiftly as possible.

• support incremental processing: a change to an individual file should not lead to the whole set of input files being re-created. Instead, only differential changes should be applied to existing data.