Table of contents layout #552
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lpil
reviewed
Oct 6, 2025
src/website/layout.gleam
Outdated
| pub fn table_of_contents_from_djot(document: jot.Document) -> List(ContentLink) { | ||
| document.content | ||
| |> list.fold(from: [], over: _, with: fn(accum, block) { | ||
| case block { |
There was a problem hiding this comment.
Flatten these nested case expressions and the list.first into a single case expression please.
src/website/layout.gleam
Outdated
| let href = | ||
| "#" | ||
| <> dict.get(attributes, "id") | ||
| |> result.unwrap("") |
There was a problem hiding this comment.
Skip if id is missing instead of rendering an invalid link
src/website/layout.gleam
Outdated
| ]) | ||
| } | ||
|
|
||
| pub fn with_toc( |
There was a problem hiding this comment.
No abbreviations in Gleam code please!
src/website/layout.gleam
Outdated
| @@ -0,0 +1,292 @@ | |||
| import gleam/dict | |||
There was a problem hiding this comment.
Merge this module back into the page module please.
The fact the PagaMeta data type no longer has an appropriate to live without creating dependency cycles shows that this is one module and not two.
src/website/layout.gleam
Outdated
| ContentLink(title: String, href: String, children: List(ContentLink)) | ||
| } | ||
|
|
||
| pub fn table_of_contents_from_djot(document: jot.Document) -> List(ContentLink) { |
There was a problem hiding this comment.
It is not currently, but it will be as soon as you use djot to write a guide like this.
src/website/site.gleam
Outdated
| /// Social media share preview image name | ||
| preload_images: List(String), | ||
| ) | ||
| } |
Includes moving the layout module back into the page module, making the djot table of contents much less ugly, and improving code style (toc -> table_of_contents)
|
Thanks, I've implemented much of this feedback now. |
foolish that I did not include this in the last commit but alas
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
G'day!
Today I come bearing a new page layout, the table of contents layout! I've had this one in the pipelines for a bit now, but I've properly factored it as a separate unit so it can be used now.
This includes a small refactor, adding a new layout.gleam file with our basic layout functions, giving some clearer distinction between page content and layout things. It also includes a function that parses Djot document content to produce a List of ContentLinks, used to build the table of contents in the layout.
For now, since I want to start small(er), I have just set it up manually on the two deployment pages.