[
https://issues.apache.org/jira/browse/THRIFT-5289?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jens Geyer reassigned THRIFT-5289:
----------------------------------
Assignee: Alexander Kashirin
> Add markdown compiler
> ---------------------
>
> Key: THRIFT-5289
> URL: https://issues.apache.org/jira/browse/THRIFT-5289
> Project: Thrift
> Issue Type: Improvement
> Components: Markdown - Compiler
> Reporter: Jens Geyer
> Assignee: Alexander Kashirin
> Priority: Major
>
> *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
> {color:#032f62}{color:#032f62}'{color}md|html{color:#032f62}'{color}{color}
> default None noescape: Do not escape with html-entities
> {color:#d73a49}in{color} 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_
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
