emmylua_doc_cli does not render Markdown tables to HTML
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, rust
- Domain
- documentation
Research direction
Start by tracing how emmylua_doc_cli parses Lua documentation comments and converts Markdown when generating HTML. Reproduce with the provided module.lua example and command, then check whether the conversion handles Markdown tables. Done when the table renders as an HTML table in the generated site.
Written by the indexing model from the issue text.
Description
How to reproduce
- create a file
module.luawith Lua chunk:
--- Module xxx
---
---### xxx
---
--- | aaa | bbb |
--- | --- | --- |
--- | 1 | 2 |
---
function new()
end
return new
- run emmylua_doc_cli:
emmylua_doc_cli module.lua -o site -f html
Actual result
table was not rendered:
Expected result
markdown table is rendered as HTML table
Version: emmylua_doc_cli 0.25.1
- Dominant language
- Rust
- Stars
- 517
- Forks
- 101
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 18
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from EmmyLuaLs/emmylua-analyzer-rust
-
luafmt: preserve_statement_semicolon = false removes a required `;` before a `(` statement, output no longer parsesPossibly taken @sean0407 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
EmmyLuaLs/emmylua-analyzer-rust#1301 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
EmmyLuaLs/emmylua-analyzer-rust#1249 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
EmmyLuaLs/emmylua-analyzer-rust#1247 · 3 comments ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
EmmyLuaLs/emmylua-analyzer-rust#1016 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
EmmyLuaLs/emmylua-analyzer-rust#1303 ·
Maintainers usually reply within 1 day
All issues in EmmyLuaLs/emmylua-analyzer-rust
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
AimesSoft/NipaPlay-Reload#1022 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ZcashFoundation/frost-tools#612 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
ScoopInstaller/Extras#19070 ·
Maintainers usually reply within 1 day
-
test: sim_zero_omega_tests race on shared temp-file names, so two pairs of tests fail at randomOpen
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100