vlang / vlang/docs

Links inside codeblocks are not rendered

Open
#25 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
33
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Markdown-format links inside codeblocks are displayed as-is. The docs generator should generate anchor elements for them.

A line in a codeblock: 'voidptr // this one is mostly used for [C interoperability](#v-and-c)'

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Reproduce the issue in the V Documentation Generator with the shown codeblock containing C interoperability. Start by tracing how Markdown links inside codeblocks are rendered. Done means those links become anchor elements instead of remaining literal Markdown text.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.