docs/index: add github links warning

This commit is contained in:
Henrik Lissner 2019-11-14 15:47:42 -05:00
parent 031a68a36d
commit 6536eded02
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -7,9 +7,10 @@ for your own Emacs configuration or a resource for enthusiasts to learn more
about our favorite OS. about our favorite OS.
#+begin_quote #+begin_quote
Doom's documentation can be viewed from within Emacs by pressing =<help> d h= Github fails to render org links to sub-sections, so it is recommended that you
(=<help>= is =SPC h= for evil users and =C-h= for vanilla users), or searched view the documentation from within Doom Emacs by pressing =<help> d h= (=<help>=
with =<help> d /=. is =SPC h= for evil users and =C-h= for vanilla users) or searching it with
=<help> d /=.
#+end_quote #+end_quote
* Table of Contents :TOC: * Table of Contents :TOC: