JuliaDocs / Documenter.jl

A documentation generator for Julia.
https://documenter.juliadocs.org
MIT License
815 stars 480 forks source link

HTML comment tag doesn't work. #176

Closed bicycle1885 closed 8 years ago

bicycle1885 commented 8 years ago

Two consecutive hyphens seem to be recognized as an em dash.

Input:

<!--
### bigBed

BigBed is a binary file format for representing genomic annotations and often
created from BED files. The bigBed files are indexed to quickly fetch specific
regions.
-->

Output:

<!–

<a id='bigBed-1'></a>

### bigBed

BigBed is a binary file format for representing genomic annotations and often created from BED files. The bigBed files are indexed to quickly fetch specific regions. –>

Documenter.jl: v0.1.6

julia> versioninfo()
Julia Version 0.4.6
Commit 2e358ce* (2016-06-19 17:16 UTC)
Platform Info:
  System: Darwin (x86_64-apple-darwin14.5.0)
  CPU: Intel(R) Core(TM) i5-4288U CPU @ 2.60GHz
  WORD_SIZE: 64
  BLAS: libopenblas (USE64BITINT DYNAMIC_ARCH NO_AFFINITY Haswell)
  LAPACK: libopenblas64_
  LIBM: libopenlibm
  LLVM: libLLVM-3.3
MichaelHatherly commented 8 years ago

Markdown.parse doesn't support raw HTML tags yet, so this is an upstream issue not specific to Documenter.

bicycle1885 commented 8 years ago

Ah, okay thanks.

MichaelHatherly commented 8 years ago

Can you open an issue in the Julia repo for this, just so it doesn't get forgotten. I don't think there's one specific to raw HTML yet. Thanks.