Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

emmylua_doc_cli does not render Markdown tables to HTML

Open Beginner friendly
#1,276 0 comments 0 reactions 0 assignees View on GitHub

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
  1. create a file module.lua with Lua chunk:
--- Module xxx
---
---### xxx
---
--- | aaa | bbb |
--- | --- | --- |
--- | 1 | 2 |
---
function new()
end

return new
  1. run emmylua_doc_cli: emmylua_doc_cli module.lua -o site -f html
Actual result

table was not rendered:

Image
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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EmmyLuaLs/emmylua-analyzer-rust

All issues in EmmyLuaLs/emmylua-analyzer-rust

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.