Add org-fc-help command

l3kn · Mar 11, 2024 · ff9ae9f · ff9ae9f
1 parent ed4c55f
commit ff9ae9f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/index.org b/docs/index.org
@@ -8,6 +8,8 @@
 
 [[file:images/review.png]]
 
+You can view this documentation in Emacs with ~M-x org-fc-help~.
+
 * Introduction
 Org-fc is a spaced-repetition system for Emacs' org-mode.
 

diff --git a/org-fc-core.el b/org-fc-core.el
@@ -733,6 +733,13 @@ Cards with no positions are removed from the index."
             (push card res)))))
     (reverse res)))
 
+;;;###autoload
+(defun org-fc-help ()
+  "Open the org-fc documentation."
+  (interactive)
+  (let ((path (expand-file-name "docs/index.org" org-fc-source-path)))
+    (find-file path)))
+
 ;;; Demo Mode
 
 ;;;###autoload