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

HTML comments in html backend #674

Closed
tknopp opened this issue Mar 17, 2018 · 2 comments
Closed

HTML comments in html backend #674

tknopp opened this issue Mar 17, 2018 · 2 comments

Comments

@tknopp
Copy link

tknopp commented Mar 17, 2018

HTML comments in the html backend are visible in the resulting documentation. Can this be changed?

@mortenpi
Copy link
Member

The Markdown parser in Julia does not parse HTML (JuliaLang/julia#17837). Also, this is somewhat a duplicate of #517, but a slightly different use case.

If you need comments in the markdown files then, as a workaround, it should be possible to use @meta blocks with just Julia comments:

```@meta
# foo
```

@odow
Copy link
Collaborator

odow commented Oct 31, 2023

I'm doing a triage of open documenter issues and closing issues that are stale. If I've made a mistake, please re-open

Closing in favor of #517, and because @meta is the appropriate tool to use for comments in Markdown files.

@odow odow closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants