branch: externals/denote-markdown
commit 4113627a7e0249baf816e98a6253fb6cc95966e6
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the denote-markdown README.md
---
README.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/README.md b/README.md
index c4485428a3..292580253e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
# Denote Markdown extras
WORK-IN-PROGRESS:
<https://protesilaos.com/codelog/2025-02-11-emacs-splitting-denote-many-packages/>.
+
+The `denote-markdown` package provides some convenience functions to
+better integrate Markdown with Deonte. This is mostly about converting
+links from one type to another so that they can work in different
+applications (because Markdown does not have a standardised way to
+define custom link types).
+
+The code of `denote-markdown` used to be bundled up with the `denote`
+package before version `4.0.0` of the latter and was available in the
+file `denote-md-extras.el`. Users of the old code will need to adapt
+their setup to use the `denote-markdown` package. This can be done by
+replacing all instances of `denote-md-extras` with `denote-markdown`
+across their configuration.
+
++ Package name (GNU ELPA): `denote-markdown` (⚠️ Not available yet)
++ Official manual: <https://protesilaos.com/emacs/denote-markdown>
++ Git repository: <https://github.com/protesilaos/denote-markdown>
++ Backronyms: Denote... Markdown's Ambitious Reimplimentations
+ Knowingly Dilute Obvious Widespread Norms; Denote... Markup
+ Agnosticism Requires Knowhow to Do Only What's Necessary.
