[PR #1057] [CLOSED] Add markdown-it-deflist for <dl> in markdown #5758

New Issue

OVERLORD · 2026-02-05T10:16:19+03:00

OVERLORD commented

2026-02-05 10:16:19 +03:00

📋 Pull Request Information

Original PR: https://github.com/BookStackApp/BookStack/pull/1057
Author: @nilium
Created: 10/11/2018
Status: ❌ Closed

Base: master ← Head: add-definition-lists

📝 Commits (1)

40e9307 Add markdown-it-deflist for
in markdown

📊 Changes

5 files changed (+21 additions, -1 deletions)

View changed files

📝 package-lock.json (+5 -0)
📝 package.json (+1 -0)
📝 resources/assets/js/components/markdown-editor.js (+2 -0)
📝 resources/assets/js/components/page-comments.js (+2 -0)
📝 resources/assets/sass/_text.scss (+11 -1)

📄 Description

This adds the markdown-it-deflist extension for markdown-it to support definition lists in the Markdown editor. In addition, there's some basic styling added to definition lists to make terms bold and indent their definitions.

Ideally this should have no negative impact on existing markdown held by a BookStack instance, but I can only speak for my team's use of BookStack. So, if this seems like something that could be merged, it might be good to hear from anyone else using BookStack if this would affect their pages.

This is intended to help with keeping glossaries and other things that fit the mold of a definition list (my team does both). That sort of formatting can always be worked around with some careful HTML, but figured I'd put this together and see if it's worth considering. Happy to make any changes if there's anything off about this, or I can close it if it doesn't seem like a good fit for BookStack.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/BookStackApp/BookStack/pull/1057 **Author:** [@nilium](https://github.com/nilium) **Created:** 10/11/2018 **Status:** ❌ Closed **Base:** `master` ← **Head:** `add-definition-lists` --- ### 📝 Commits (1) - [`40e9307`](https://github.com/BookStackApp/BookStack/commit/40e9307ff6528827f5f5b715f05b5562d00ad98b) Add markdown-it-deflist for <dl> in markdown ### 📊 Changes **5 files changed** (+21 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `package-lock.json` (+5 -0) 📝 `package.json` (+1 -0) 📝 `resources/assets/js/components/markdown-editor.js` (+2 -0) 📝 `resources/assets/js/components/page-comments.js` (+2 -0) 📝 `resources/assets/sass/_text.scss` (+11 -1) </details> ### 📄 Description This adds the markdown-it-deflist extension for markdown-it to support definition lists in the Markdown editor. In addition, there's some basic styling added to definition lists to make terms bold and indent their definitions. Ideally this should have no negative impact on existing markdown held by a BookStack instance, but I can only speak for my team's use of BookStack. So, if this seems like something that could be merged, it might be good to hear from anyone else using BookStack if this would affect their pages. This is intended to help with keeping glossaries and other things that fit the mold of a definition list (my team does both). That sort of formatting can always be worked around with some careful HTML, but figured I'd put this together and see if it's worth considering. Happy to make any changes if there's anything off about this, or I can close it if it doesn't seem like a good fit for BookStack. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2026-02-05 10:16:19 +03:00

OVERLORD closed this issue

2026-02-05 10:16:21 +03:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5758