vlang / vlang/docs

`> [!NOTE]` md syntax not recognized

Open
#17 0 comments 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

Not sure if this the right place to report the issue, but the new-ish GH-flavored markdown extension of note's and the like are not converted to html on the current version of the docs.

E.g. on https://docs.vlang.io/v-types.html#primitive-types:

image

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 at the linked v-types.html#primitive-types page and inspect the documentation generator's Markdown rendering entry point. Confirm how > [!NOTE] is currently handled, then verify that the rendered documentation produces the intended note HTML.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.