TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix links in documentation which breaks org html export 

Since org 9 internal links must be declared either as #customID
or textTargetOrFullTextSearch. Relative path links must
be either file:relative/path or ./relative/path. Many links
are using the #customID form to trigger a full text search which is not
defined as to the org documentation. In addition relative file paths are
declared as relative/path which is also not defined. If this is done
the html export can fail. Therefore these links must be corrected
for the files where they break the html export.
Fixes #8054 for all spacemacs documentation files.
This commit is contained in:
smile13241324 2017-01-08 16:37:34 +01:00 committed by syl20bnr
parent 70c6fcef02
commit 84c36ade86
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.org
View File

@ -25,18 +25,24 @@ Thanks! :heart: :heart: :heart:
- [[#credits][Credits]]
* Asking for help
:PROPERTIES:
:CUSTOM_ID: asking-for-help
:END:
If you want to ask an usage question, be sure to look first into some places as
it may hold the answer:
- [[doc/FAQ.org][The FAQ]]. Some of the most frequently asked questions are answered there.
- [[doc/DOCUMENTATION.org][The documentation]]. It's the general documentation of Spacemacs.
- You may also read the =README.org= of the [[layers/][relevant layer(s)]].
- [[file:doc/FAQ.org][The FAQ]]. Some of the most frequently asked questions are answered there.
- [[file:doc/DOCUMENTATION.org][The documentation]]. It's the general documentation of Spacemacs.
- You may also read the =README.org= of the [[file:layers/][relevant layer(s)]].
If your question is not answered there, then please come into our [[https://gitter.im/syl20bnr/spacemacs][gitter chat]] to
discuss it with us :relaxed:. We will direct you to a solution, or ask you to
open an issue if it is needed.
* Reporting issues
:PROPERTIES:
:CUSTOM_ID: reporting-issues
:END:
Issues have to be reported on our [[https://github.com/syl20bnr/spacemacs/issues][issues tracker]]. Please:
- Check that the issue has not already been reported.
@ -56,6 +62,9 @@ Issues have to be reported on our [[https://github.com/syl20bnr/spacemacs/issues
step guide.
* Contributing code
:PROPERTIES:
:CUSTOM_ID: contributing-code
:END:
Code contributions are welcome. Please read the following sections carefully. In
any case, feel free to join us on the [[https://gitter.im/syl20bnr/spacemacs][gitter chat]] to ask questions about
contributing!
@ -198,7 +207,7 @@ can be done from the =dotspacemacs/user-config= function of your =.spacemacs=
file and don't require any contribution to Spacemacs.
If you think it worth contributing a new key bindings then be sure to read
the [[doc/CONVENTIONS.org][CONVENTIONS.org]] file to find the best key bindings, then create a
the [[file:doc/CONVENTIONS.org][CONVENTIONS.org]] file to find the best key bindings, then create a
Pull-Request with your changes.
*ALWAYS* document your new keybindings or keybindings changes inside the

3
doc/BEGINNERS_TUTORIAL.org
View File

@ -228,6 +228,9 @@ a very common task and is done with ~SPC f r~. An edited file is saved with
~SPC f s~.
* Configuring Spacemacs
:PROPERTIES:
:CUSTOM_ID: configuring-spacemacs
:END:
** Adding language support and other features: using layers
Spacemacs divides its configuration into self-contained units called
configuration layers. These layers are stacked on top of each other to achieve a