Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OSPO Book] Table of contents #360

Open
cornelius opened this issue Aug 25, 2023 · 3 comments
Open

[OSPO Book] Table of contents #360

cornelius opened this issue Aug 25, 2023 · 3 comments

Comments

@cornelius
Copy link
Member

The table of content contains the list of chapters and some notes about their content. It would be good to link the entries in the table of content to the actual chapters.

I'm not sure how to do this with hugo in a way that it shows up on the generated site correctly. If you have a hint for me how to do it, I can also come up with a pull request.

For the chapters which aren't completed yet there is no content on the generated site yet. So it would be good to add a note that it is work in progress instead of the link.

@alice-sowerby alice-sowerby changed the title [OSPO Book] Link chapters from table of content [OSPO Book] Table of contents Jun 3, 2024
@alice-sowerby
Copy link
Contributor

I am repurposing this issue to represent the Table of Contents (TOC) on the Project Board as the TOC will need to be updated regularly.

@alice-sowerby
Copy link
Contributor

I think it would also be worth including "Chapter X" at the start of each chapter, as it's unclear in the live book which chapter is which (and the chapters are numbered in the TOC). The alternative would be to remove chapter numbers altogether, but I think that is less useful.

@koozz
Copy link
Member

koozz commented Jun 3, 2024

I thought it was just the page link + the anchor (just like what you get on hovering a heading in the GitHub markdown docs):

image

02-chapter.md#supply-chain-and-open-source is the link according to GitHub, but Hugo will render it as 02-chapter/#supply-chain-and-open-source.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Write and Edit
Development

No branches or pull requests

3 participants