Documentation #504

New Issue

claunia · 2026-01-29T14:38:21Z

claunia commented

2026-01-29 14:38:21 +00:00

Originally created by @mattj23 on GitHub (Feb 19, 2022).

@xoofx, thanks for this incredible library.

I'm using it in one of my own projects, and I noticed that you've been intending to write full documentation but life and other projects keep getting in the way.

Is this something you want help with? I'm currently motivated to try to understand the library for my own use and writing documentation is something I don't mind doing. I'd be happy to start laying out some of the documentation (especially on the parser side) if you'd be available to review it and answer some general questions about how the library is laid out as they come up.

I'm also not offended if this is something you'd prefer to do yourself.

Here's an example of one of my own projects from a few years ago that keeps getting buried under other priorities if you want to see an example of my writing:

https://github.com/mattj23/InteractiveReadLine

Originally created by @mattj23 on GitHub (Feb 19, 2022). @xoofx, thanks for this incredible library. I'm using it in one of my own projects, and I noticed that you've been intending to write full documentation but life and other projects keep getting in the way. Is this something you want help with? I'm currently motivated to try to understand the library for my own use and writing documentation is something I don't mind doing. I'd be happy to start laying out some of the documentation (especially on the parser side) if you'd be available to review it and answer some general questions about how the library is laid out as they come up. I'm also not offended if this is something you'd prefer to do yourself. --- Here's an example of one of my own projects from a few years ago that keeps getting buried under other priorities if you want to see an example of my writing: https://github.com/mattj23/InteractiveReadLine

claunia added the PR Welcome!documentation labels 2026-01-29 14:38:21 +00:00

claunia commented

2026-01-29 14:38:22 +00:00

@xoofx commented on GitHub (Feb 21, 2022):

Is this something you want help with?

Definitely! 🙂

You can create markdown files under a root doc folder. I plan to push a website at some point with them that will integrate also a generated API Reference. So it's very welcome.

@xoofx commented on GitHub (Feb 21, 2022): > Is this something you want help with? Definitely! 🙂 You can create markdown files under a root `doc` folder. I plan to push a website at some point with them that will integrate also a generated API Reference. So it's very welcome.

claunia referenced this issue

2026-01-29 14:52:32 +00:00

[PR #891] [MERGED] Fix for table depth error when cell contains backticks #1280

claunia referenced this issue

2026-01-29 14:52:36 +00:00

[PR #891] Fix for table depth error when cell contains backticks #1285

Sign in to join this conversation.