they should all point to https://develop.spacemacs.org
instead.
I have also removed the warning from the
develop documentation as this is now the recommended
branch.
The script used to identify and update the change is added into the GitHub
workflows script directory. A workflow action can be created to trigger the
script to update the headers on the first of every new year. Possibly a task for
a consequent PR.
* Warn user they are reading develop docs
Draft commit, definitely still needs work.
The intent is to let users know they are reading documentation that might not
apply to their version of spacemacs. The default install is based on master,
but the docs for both master and develop show up in search engine results.
Currently the only way to see that you are reading the develop docs is by
looking at the subdomain. You'd also need to know that a non-develop website
exists, which is not obvious.
* Use real redirect link back to non-develop docs
Co-authored-by: Lucius Hu <lebensterben@users.noreply.github.com>
Some of the layers do not supply a README.org file which caused
invalid links in the layer list. To avoid this I have changed
spacemacs//generate-layers-from-path to only add links to layers
with a valid README.org file.
I have also removed an invalid check to exclude the non existing directory
"distribution" from the layers list. I think that originally the folder
"distributions" should have been excluded but this is not longer
a feasible action as there is at least one layer with a valid README.org
file in there today. So now we add links to all layers providing a
README.org file independent of their category.
In 2015 a file CONTRIBUTE.org was existing in the /doc folder.
In addition a CONTRIBUTING.md file was existing in the project root folder.
This was merged into a CONTRIBUTING.org file, which is still located in the project root.
However the documentation publishing system was still looking only in the doc folder.
In addition the external documentation is still referring to the old CONTRIBUTE.html which is not longer existing.
I have now included a new function called prior to publishing
which is copying the documents from the projects root into the doc folder.
As a side effect it renames the CONTRIBUTING.org to the old CONTRIBUTE.org
to support the external documentation.
With this new variable, user can load spacemacs anywhere, e.g.
"~/.emacs.d/spacemacs/". Only user's cache directory is still hard-coded
as "~/.emacs.d/.cache/". If user want to use spacemacs this way, drop
one line as the below in "~/.emacs.d/init.el":
(setq spacemacs-start-directory "~/.emacs.d/spacemacs/")
(load-file (concat spacemacs-start-directory "init.el"))
Add new html preprocessors to the org-html-publish-to-html pipeline:
- `spacemacs//toc-org-unhrefify-toc`
- remove the `toc-org` modifications for the TOC
- `spacemacs//org-heading-annotate-custom-id`
- annotate org headings with the indexes that GitHub uses for linking.
`org-html-publish-to-html` will use them instead of the default
`#orgheadline{N}`. This way the GitHub links and the
http://spacemacs.org/ links will be compatible."
- `spacemacs//reroot-links`
- find the links that start with
https://github.com/syl20bnr/spacemacs/blob/ and end with
.org{#an-optional-heading-link} (i.e the links between the local org
files). Change their root to http://spacemacs.org/ so the links will
point at files located on the site.
*For the "file to file" links to work properly the expor
Maxi Wolff
Jonas Jelten
Arif Er
Eugene Yaremenko
Thanh
Evelyn Liang
syl20bnr
Robert O'Connor
Anton-Latukha
nashamri
Exaos-memes
Xue Fuqiao