bookmark-all-names returns a list of names, but
spacemacs-buffer//insert-file-list expect a list of filenames.
Shortcut definitions seems to be a mix of two approaches/commits.
Removed the unused bits.
- lists were not correctly indented sometimes
- **note** and such things do not exist in org
- Note and Important
- Change Feature list to heading
- Change TODOS to actual org TODOS
- Add TOC to python layer
- list indentation
- some typos I could not leave unchanged
- TODO formatting
- List indentation
- typos
- wrong markup
fix conversion issues
Refactor spacemacs/open-file to spacemacs/view-org-file to correctly
reflect its functionality. In Emacs, view means read-only. Make the
anchor-text optional so we can omit when not needed. Also add
expand-scope that can be either 'subtree or 'all to open a tree at point
or expand everything. 'subtree is used for the Change Log while 'all is
used for all Spacemacs documents.
Currently helm-spacemacs//documentation-candidates grabs everything it
can in the doc directory. In the future we might put some images there
so better just choose the correct file type to include.
As this includes 4 levels of headings, the tag that needs to be used is
:TOC@4:. Now every time one saves this file, the TOC is automatically
generated. There is an interesting feature from toc-org that enables
users to use org links or GitHub enabled
[links](https://github.com/snosov1/toc-org#use)
we should discuss how to use it because on one hand, having org links
makes it easier to read in emacs, while having GitHub links makes it
easier to read online.
Since Helm can candidates can also be a alist of '(DISPLAY . REAL),
where DISPLAY is the text to be displayed for a candidate when it is
listed and REAL is the actual object DISPLAY is presenting, we can use
this feature to give appropriate document titles instead of using raw
file names.
This commit also changes the way we create document source: instead
defining an alist, we properly create it with `helm-build-sync-source`,
similar to how Helm Projectile does it.
Also, we do not need to sort the file list getting from the doc/
directory just reverse the list.
Since both offer the same functionality, but except for staging hunk but
it works only with Git anyway.
diff-hl has the advantage that it is usable with left/right fringes and
margin in a single package. Also it does not have the bugs that
git-gutter is having.
- Use `~` marker to represent key bindings. The `~` and `=` markers are
equivalent in Emacs: `=` uses `org-verbatim verbatim` faces, while `~`
uses `org-code verbatim)`, but both `org-verbatim` and `org-code` is
inherited from `shadow` face. So we can use `~` marker for this purpose.
`~` marker is also displayed properly on Github, since it's part of
standard Emacs, so no web functionality is broken.
- Add org-kbd face for displaying key bindings.
- Update CHANGELOG.org: use the proper `~` marker for key bindings.
- Update VIMUSERS.org: use the proper `~` marker for key bindings.
Reuse spacemacs/open-file that is used for viewing the Change Log when
the opened file is an Org file. It means the following things:
- The document is in `view-mode` just for reading, as it should be, so
user won't mess things up while reading their doc.
- After PR #1902 is merged, it enhances reading experience.