[jira] [Commented] (IOTDB-974) rewrite the tables from HTML language to markdown grammer in all md files

["ZHOU JESSE (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/IOTDB-974?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17225359#comment-17225359 ] 

ZHOU JESSE commented on IOTDB-974:
----------------------------------

when rewriting the tables into markdown grammar, I encountered this tricky problem.

Specifically speaking, in {color:#FF0000}docs/UserGuide/System Tools/Memory Estimation Tool.md{color}, there is this parameter called "*-sg | --storagegroup <storage group number>*" in a table. As you can see, the "*|*" in the this string were recognized as part of the table in markdown grammar, thereby the table couldn't be finished.

Maybe someone can give me a hint on what to do to solve this problem? 

> rewrite the tables from HTML language to markdown grammer in all md files
> -------------------------------------------------------------------------
>
>                 Key: IOTDB-974
>                 URL: https://issues.apache.org/jira/browse/IOTDB-974
>             Project: Apache IoTDB
>          Issue Type: Task
>          Components: Document
>            Reporter: Xiangdong Huang
>            Priority: Major
>              Labels: easy-fix
>
> Recently I find some docs are using HTML grammar to represent a table, 
> e.g., in docs/UserGuide/System Tools/Sync Tool.md,  we are using <table> ...
>  
> However,  using "|" is better in markdown files and can be recognized by many renders.
> e.g., in docs/zh/UserGuide/V0.9.x/7-Ecosystem Integration/5-Hive TsFile.md
> | TsFile 数据类型 | Hive 数据类型 |
> | ---------------- | --------------- |
> | BOOLEAN | Boolean |
> | INT32 | INT |
> | INT64 | BIGINT |
> | FLOAT | Float |
> | DOUBLE | Double |
> | TEXT | STRING |
>  
> So, I'd like to call a task to convert all table with HTML "<table>" to markdown "|".
>  
> If so, we can very easy to use tools like `pandoc` to generate pdf user guide file from all markdown files.
>  



--
This message was sent by Atlassian Jira
(v8.3.4#803005)