starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[PR #2161] [CLOSED] Support markdown in book descriptions #3662

New Issue
Closed
opened 2026-04-25 00:16:33 +02:00 by adam · 0 comments
adam commented 2026-04-25 00:16:33 +02:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/2161
Author: @MxMarx
Created: 9/30/2023
Status: ❌ Closed

Base: master ← Head: markdown-descriptions

📝 Commits (1)

  • 41b685d support markdown in descriptions

📊 Changes

6 files changed (+42 additions, -8 deletions)

View changed files

📝 client/pages/item/_id/index.vue (+4 -2)
📝 package-lock.json (+28 -1)
📝 package.json (+1 -0)
📝 server/providers/Audible.js (+3 -2)
📝 server/providers/iTunes.js (+3 -1)
📝 server/utils/parsers/parseOpfMetadata.js (+3 -2)

📄 Description

It would be pretty nice to have a little rich text in book descriptions, mostly so line breaks are preserved when fetching metadata.
This pull request uses turndown to convert book descriptions grabbed from Audible or iTunes into markdown, and since marked is already included to render the changelog, rendering markdown in the descriptions is pretty easy.

Alternatively, we could use the trix editor currently used for podcast episodes instead of using markdown. If this is something planned for the future, it might make more sense to store rich text descriptions as sanitized html instead of markdown. I could also make a pull request with the trix editor instead if wanted.

resolves #617
resolves #1820

🔄 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/advplyr/audiobookshelf/pull/2161 **Author:** [@MxMarx](https://github.com/MxMarx) **Created:** 9/30/2023 **Status:** ❌ Closed **Base:** `master` ← **Head:** `markdown-descriptions` --- ### 📝 Commits (1) - [`41b685d`](https://github.com/advplyr/audiobookshelf/commit/41b685d118c7b6bf492beb5a91cf01436e3d42da) support markdown in descriptions ### 📊 Changes **6 files changed** (+42 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `client/pages/item/_id/index.vue` (+4 -2) 📝 `package-lock.json` (+28 -1) 📝 `package.json` (+1 -0) 📝 `server/providers/Audible.js` (+3 -2) 📝 `server/providers/iTunes.js` (+3 -1) 📝 `server/utils/parsers/parseOpfMetadata.js` (+3 -2) </details> ### 📄 Description It would be pretty nice to have a little rich text in book descriptions, mostly so line breaks are preserved when fetching metadata. This pull request uses [turndown](https://github.com/mixmark-io/turndown) to convert book descriptions grabbed from Audible or iTunes into markdown, and since [marked](https://github.com/markedjs/marked) is already included to render the changelog, rendering markdown in the descriptions is pretty easy. Alternatively, we could use the trix editor currently used for podcast episodes instead of using markdown. If this is something planned for the future, it might make more sense to store rich text descriptions as sanitized html instead of markdown. I could also make a pull request with the trix editor instead if wanted. resolves #617 resolves #1820 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:16:33 +02:00
adam closed this issue 2026-04-25 00:16:33 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3662
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?