[THRIFT-5289] Add markdown compiler

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.14.0
• Component/s: Markdown - Compiler
• Patch Info: Patch Available
• Assignee: Kashirin Alex
• Reporter: Jens Geyer
• Created: 05/Oct/20 06:45
• Updated: 11/Feb/21 22:26
• Resolved: 05/Oct/20 06:48

Description

Added a Markdown Generator:
generate documentations in 'markdown' format
The main reason is that some builds break with markdown files that include html.

The thrift --help is now with a generator 'markdown' option:
markdown (MARKDOWN): suffix: Create files/links with/out 'md|html' default None noescape: Do not escape with html-entities in doc text.
Some Markdown Generator Results Available at:

• a direct view of a 'md' files
  • https://github.com/kashirin-alex/swc-db/blob/master/src/thrift/swcdb/README.md
  • https://github.com/kashirin-alex/swc-db/tree/master/docs/use/thriftclient#the-swc-db-thrift-modules
• a view of docs-generators:
  • mkdocs build - https://swc-db.readthedocs.io/en/latest/use/thriftclient/
  • GitHub Jekyll theme build - https://kashirin-alex.github.io/swc-db/use/thriftclient/#the-swc-db-thrift-modules

Note:
-- the t_markdown_generator.cc is mostly based on the t_html_generator.cc, while both can be improved by using structured template for populating data by the specific-structure

Issue Links

• links to: Pull request #2241