apache / apache/maven-doxia

[DOXIA-713] Document limitations of the parsers/sinks

Open
#695 0 comments 0 reactions 0 assignees View on GitHub
enhancement priority:major
Dominant language
Java
Stars
34
Forks
54
Avg merge
1d 12h
Merged PRs (30d)
16

Description

**[Konrad Windszus](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=kwin)** opened **[DOXIA-713](https://issues.apache.org/jira/browse/DOXIA-713?redirect=false)** and commented

Due to the Sink API abstractions some language features of the underlying markup languages or the Sink API are not supported for parsers and/or sinks. Those should be documented at https://maven.apache.org/doxia/references/index.html.
Examples are:
- markdown sink: anchor
- markdown sink: figure (only via HTML markup)
- markdown sink: table justification
.....

---
No further details from [DOXIA-713](https://issues.apache.org/jira/browse/DOXIA-713?redirect=false)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the Doxia references page linked in the issue and review the parser and sink behavior, beginning with the Markdown sink examples listed: anchors, figures, and table justification. Done means the relevant unsupported or limited language features are documented clearly on that page, including any additional limitations found during the review.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.