branch: elpa/hyperdrive
commit dbf3d5063f7a6c95ac27dff23eb4456ce9a270b5
Author: Joseph Turner <[email protected]>
Commit: Joseph Turner <[email protected]>
Docs: Document Markdown relative links
---
doc/hyperdrive.org | 6 ++++++
doc/hyperdrive.texi | 9 +++++++++
2 files changed, 15 insertions(+)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index d2e4ab7653..7a6c9dde40 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -358,6 +358,12 @@ in org-mode), then typing ~hyper:~ and ~RET~. To change
how
~org-insert-link~ inserts links to files within the same hyperdrive,
adjust ~hyperdrive-org-link-full-url~ and ~org-link-file-path-type~.
+*** Markdown links
+
+Relative links are supported; within ~hyper://PUBLIC-KEY/foo.md~, the
+links ~[bar](<bar.md>)~, ~[bar](<./bar.md>)~, and ~[bar](</bar.md>)~ will
+all point to ~hyper://PUBLIC-KEY/bar.md~.
+
** Delete a hyperdrive file
#+findex: hyperdrive-delete
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 0a652646f1..219e93a9d4 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -106,6 +106,7 @@ Open a hyperdrive
Link to a hyperdrive
* Org mode links::
+* Markdown links::
View the hyperdrive version history
@@ -594,6 +595,7 @@ file or directory.
@menu
* Org mode links::
+* Markdown links::
@end menu
@node Org mode links
@@ -619,6 +621,13 @@ in org-mode), then typing @code{hyper:} and @code{RET}.
To change how
@code{org-insert-link} inserts links to files within the same hyperdrive,
adjust @code{hyperdrive-org-link-full-url} and @code{org-link-file-path-type}.
+@node Markdown links
+@subsection Markdown links
+
+Relative links are supported; within @code{hyper://PUBLIC-KEY/foo.md}, the
+links @code{[bar](<bar.md>)}, @code{[bar](<./bar.md>)}, and
@code{[bar](</bar.md>)} will
+all point to @code{hyper://PUBLIC-KEY/bar.md}.
+
@node Delete a hyperdrive file
@section Delete a hyperdrive file
