Replies: 1 comment
-
Yes, agreed. I've made an issue for this! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
We need to build our own Gleam documentation server that works similarly to https://hexdocs.pm/, but builds documentation by accessing our private repositories containing private Gleam packages for our team's use.
The documentation updater clones the repositories and modifies the
gleam.toml
file to add back-links to the documentation server index. This is typically an HTTPS address for our documentation server, but when running locally, it's something likehttp://localhost:8000
.We attempted to add
links = [{ title = "Home", href = "/index.html" }]
to thegleam.toml
file, but this doesn't work because the documentation builder validates that links have a valid scheme, throwing an error:uri without scheme for key 'links'...
.Is this validation really necessary? It also prevents adding relative links within the documentation (including fragment identifiers using "#").
We could work around this by using a fixed URI and performing string replacement in the generated documentation, but this approach feels clunky and inelegant.
Beta Was this translation helpful? Give feedback.
All reactions