jCloud/jcloud-docsgen

1 Fork 0

generated from jCloud/repository-template

T

jakob.scheid a6b5e8f1c9

fix(markdown): escape pipe characters in table cells

Pipe characters ('|') in Markdown table cells are now replaced with an
escape sequence ('\|') to ensure that cells are not split by Markdown
renderers.

Tests which expected pipe characters to be unescaped, which is
incorrect, were updatedto expect an escape sequence and new test cases
to ensure the correct escaping behavior were added.

2026-10-21 12:15:53 +02:00

.gitea/workflows

fix(ci): fix API reference configuration error

2026-09-28 01:25:16 +02:00

docs(changelog): move Unreleased section to 0.2.2

2026-10-14 23:58:11 +02:00

chore: add setup script

2026-09-21 22:27:28 +02:00

src/jcloud_docsgen

fix(markdown): escape pipe characters in table cells

2026-10-21 12:15:53 +02:00

fix(markdown): escape pipe characters in table cells

2026-10-21 12:15:53 +02:00

.gitignore

chore: add VS Code directory to gitignore

2026-09-05 13:47:11 +02:00

.gitmessage

chore: add commit message template

2026-09-21 22:21:40 +02:00

LICENSE

Update licenses

2026-04-30 19:28:53 +02:00

poetry.lock

fix(deps): add typing-extensions

2026-10-14 23:49:36 +02:00

pyproject.toml

chore: update project version in pyproject.toml

2026-10-14 23:57:37 +02:00

README.md

docs(readme): update installation instructions

2026-09-22 12:37:10 +02:00

README.md

jcloud-docsgen

A tool that generates Markdown documentation from software project source code.

Currently supported programming languages:

Python

Installation

You can install the package jcloud-docsgen from the Gitea Package Registry.

Setup

Please execute scripts/setup.sh when cloning the repository to configure Git.

Reference

API reference and generated documentation can be found in docs/reference.

Notice

This project is under active development. The documentation will be expanded over time.