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.

Sign up for GitHub

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

Jump to bottom

Add optional index description functionality #313

Closed
wants to merge 1 commit into from
Closed

Add optional index description functionality #313

wants to merge 1 commit into from

Conversation

daffidwilde
Copy link

@daffidwilde daffidwilde commented Dec 6, 2023 •
edited
Loading

Fixes #312.

It was such a small addition I went ahead and made the PR. Apologies that I'm pulling into main...

I haven't written any specific tests for this functionality, although I am happy to do so if you can point me in the right direction.

I have tested it locally on the project I mentioned in the issue.

Let me know what you think 😄

@machow machow mentioned this pull request Dec 7, 2023
Open
@has2k1
Copy link
Contributor

has2k1 commented Dec 11, 2023

Ideally, in the Builder class this should stop at adding builder.description and then the renderer would generate the markdown (ref #314).

@daffidwilde
Copy link
Author

Thanks for reviewing this @has2k1

I have tried to use the custom index page functionality (as suggested in #312) to get what I need to no avail, and I can appreciate that the Builder class is not the place for this change.

It sounds like #314 is the way to go and I will close this PR 😃

@daffidwilde daffidwilde deleted the 312-index-description branch December 11, 2023 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Allow disabling title of reference page
2 participants
@daffidwilde @has2k1