Gleam: Ability to add extra pages to the gleam docs output.

Created on 12 May 2020  路  4Comments  路  Source: gleam-lang/gleam

It's a good Default to add the Readme as a page, however I would like to be able to specify other pages of markdown that should be included.

Not sure where this declaration of markdown pages should go. Perhaps Gleam.toml?

good first issue help wanted

Most helpful comment

New here; just wanted to say I'm working on this one. :)

All 4 comments

I think that's a good idea.

Here's my thoughts on the config format:

name = "my_library"

[docs]
pages = [
  { title = "Hello", path = "", source = "README.md" },
  { title = "Testing", path = "testing", source = "docs/testing.md" },
]

New here; just wanted to say I'm working on this one. :)

Thank you @borski !

Awesome @borski I will definitely be using this, thanks

Was this page helpful?
0 / 5 - 0 ratings