Skip to content

README collapsibe details, notes, etc.#242

Merged
attipaci merged 1 commit into
mainfrom
markdown-details
Sep 11, 2025
Merged

README collapsibe details, notes, etc.#242
attipaci merged 1 commit into
mainfrom
markdown-details

Conversation

@attipaci

@attipaci attipaci commented Sep 10, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Improve the readability of the README, by

  • collapsing non-essential details initially. They can be expanded if needed.
  • Adding notes, important tidbits, warnings etc., e.g. on special cases.

@attipaci attipaci added this to the 1.5.0 milestone Sep 10, 2025
@attipaci attipaci self-assigned this Sep 10, 2025
@attipaci attipaci added the enhancement New feature or request label Sep 10, 2025
@attipaci attipaci force-pushed the markdown-details branch 3 times, most recently from 879e616 to 8460fcd Compare September 10, 2025 21:29
@attipaci attipaci marked this pull request as ready for review September 10, 2025 21:30
@attipaci attipaci force-pushed the markdown-details branch 13 times, most recently from cc6de4c to 9135a7f Compare September 10, 2025 22:00
@attipaci attipaci merged commit f277d72 into main Sep 11, 2025
7 checks passed
@attipaci attipaci deleted the markdown-details branch September 11, 2025 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@attipaci attipaci

Labels

enhancement New feature or request

Projects

None yet

Milestone

1.5.0

Development

Successfully merging this pull request may close these issues.

1 participant

@attipaci