Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add markdown parsing support with internal hyperlink detection for doc comments #3411

Open
andrewrk opened this issue Oct 9, 2019 · 1 comment
Labels
contributor friendly This issue is limited in scope and/or knowledge of Zig internals. docs
Milestone

Comments

@andrewrk
Copy link
Member

andrewrk commented Oct 9, 2019

function markdown(mdText) {
// TODO implement more
return escapeHtml(mdText);
}

I labeled this a contributor friendly issue, however, there are some restrictions on the markdown parsing:

  • we should look for internal documentation hyperlinks in the doc comments (this can be a separate contribution)
  • no npm or third party modules. We'll have our own custom minimal implementation. It's fine, don't worry about it.
@andrewrk andrewrk added contributor friendly This issue is limited in scope and/or knowledge of Zig internals. docs labels Oct 9, 2019
@andrewrk andrewrk added this to the 0.6.0 milestone Oct 9, 2019
@andrewrk andrewrk modified the milestones: 0.6.0, 0.7.0 Feb 18, 2020
@strangebug
Copy link

Hello,

Concerning this issue, the documentation in the javascript specify [[std;format.fmt]] as inner link format
https://github.com/ziglang/zig/blob/master/lib/std/special/docs/main.js#L1480

It is the intended format ?

@andrewrk andrewrk modified the milestones: 0.7.0, 0.8.0 Oct 17, 2020
@andrewrk andrewrk modified the milestones: 0.8.0, 0.9.0 Nov 6, 2020
@andrewrk andrewrk modified the milestones: 0.9.0, 0.10.0 May 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor friendly This issue is limited in scope and/or knowledge of Zig internals. docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants