toml-lang / toml.io

Source Code for toml.io
https://toml.io
MIT License
42 stars 44 forks source link

Navbar and body links are different #14

Closed ju-sh closed 4 years ago

ju-sh commented 4 years ago

In the page for the 1.0.0.-rc.1 version (https://toml.io/en/v1.0.0-rc.1), under 'Key-Value pair', the links to the types (like string, integer, etc) do not lead to the corresponding content.

But the links in the navigation pane on the left leads to the content.

The hrefs in the links of navigation pane have 'section-' in them and the links under 'Key-Value pair' has 'user-content-'.

And which static site generator is used for the website?

cannikin commented 4 years ago

Fixed! This was due to the specs assuming they were going be displayed in GitHub's README-markdown-to-HTML format so they included a prefixed "user-content" on each anchor (which GH inserts for linking to other parts of the README).

The generator is a really simple framework I built, CameronJS. The build script that converts markdown to HTML is custom in this case.

garazdawi commented 4 years ago

The same problem exists in the rc2 documentation.

cannikin commented 4 years ago

@garazdawi This should be fixed!

pradyunsg commented 4 years ago

Argh, I guess we should do this transform as part of the release process, i.e. in https://github.com/toml-lang/toml/blob/master/scripts/release.py.