Missing tags implementation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 277
- Forks
- 94
- Avg merge
- 8m
- Merged PRs (30d)
- 8
Description
As pages can now be generated, there is a need in implementing missing tags, because pages are more detailed, descriptive & general-purpose. By testing against Urho's and SFML's doc i found some tags that are needed to be transformed into markdown, and not just ignored & kept in plain text:
here is a few of some that i encountered and worked on locally.
| tagname | Markdown Equivalent (Proposal) | Seen at |
|---|---|---|
| verbatim | raw codeblock | https://urho3d.github.io/documentation/1.7/_building.html#Build_Scripts |
| title | Equivalent to headings | https://www.sfml-dev.org/documentation/2.4.2/ "Welcome" "Short Example" |
| linebreak | 2 spaces | common |
| varlistentry (followed by listitem) | two-row table | https://www.sfml-dev.org/documentation/2.4.2/deprecated.php The whole document is a variablelist, containing varlistentry strictly followed by a listitem |
| term | bold equivalent | https://www.sfml-dev.org/documentation/2.4.2/deprecated.php each "Class" "Member" + arguments of the prototype |
Special Characters:
- mdash
- ndash
- Aumlaut (Oumlaut etc)
- and all others special characters (http://www.starr.net/is/type/htmlcodes.html)
there are also other types of anchor tags comparable to "ref", like "anchor" and "sectX" (where X = 1,2,3 ..)
For now i'm testing Doxygen XML and moxygen's output by checking the official rendered version of well-known projects documentations, i think it would be great to have testing documents (from doxygen testing at first, and then develop a fine-grained testing suite)
Contributor 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.
Research direction
Compare Doxygen XML and moxygen output against the Urho3D and SFML documentation examples linked in the issue. Trace how tags such as verbatim, title, linebreak, varlistentry, term, special characters, and anchor variants are currently handled, then add focused testing documents covering the proposed Markdown equivalents and confirm the rendered output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100