From 6536eded02f7367c409792bf1bd78f7d5a33bf42 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Thu, 14 Nov 2019 15:47:42 -0500 Subject: [PATCH] docs/index: add github links warning --- docs/index.org | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/index.org b/docs/index.org index 9b34c9800..eadfd4f4c 100644 --- a/docs/index.org +++ b/docs/index.org @@ -7,9 +7,10 @@ for your own Emacs configuration or a resource for enthusiasts to learn more about our favorite OS. #+begin_quote -Doom's documentation can be viewed from within Emacs by pressing = d h= -(== is =SPC h= for evil users and =C-h= for vanilla users), or searched -with = d /=. +Github fails to render org links to sub-sections, so it is recommended that you +view the documentation from within Doom Emacs by pressing = d h= (== +is =SPC h= for evil users and =C-h= for vanilla users) or searching it with += d /=. #+end_quote * Table of Contents :TOC: