[elpa] externals/org-remark 05e18aa08c 30/37: docs: README + user manual

[ELPA Syncer]

branch: externals/org-remark
commit 05e18aa08ce7113c598f1b2d81d018e7cbb612d4
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs: README + user manual
---
 README.org          | 25 ++++++++++++++-----------
 docs/org-remark.org |  2 +-
 2 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/README.org b/README.org
index 4c4bb0dd30..3587e37fd3 100644
--- a/README.org
+++ b/README.org
@@ -11,7 +11,9 @@
 * Introduction
 
 Org-remark lets you highlight and annotate text files and websites with
-using Org mode.
+using Org mode [fn:1].
+
+[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.
 
 A user manual is available [[https://nobiot.github.io/org-remark/][online]] or 
Emacs in-system as an Info node `(org-remark)': (~C-h i~ and find the 
=Org-remark= node).
 
@@ -23,6 +25,14 @@ For customization, refer to the customization group 
`org-remark' or user manual:
 
 An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8 minutes) is 
available on YouTube.
 
+* Features
+
+- Highlight and annotate any text file. The highlights and notes are kepted in 
an Org file as the plain text database. This lets you easily manage your 
marginal notes and use the built-in Org fecilities on them -- e.g. create a 
sparse tree based on the category of the notes
+
+- Have the same highlighting and annotating functionality for websites when 
you use EWW to browse them (new in latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.)
+
+- Create your your own highlighter pens with different colors, type (e.g. 
underline, squiggle, etc. optionally with Org's category for search and filter 
on your highlights and notes)
+
 * Screenshots and Videos                                           :noexport:
 
 [[./resources/images/2022-01-22-Title.png]]
@@ -75,13 +85,6 @@ Below are example keybindings you might like to consider:
     (define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-view-prev)
     (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
 #+end_src
-* Features
-
-- Highlight and annotate any text file. The highlights and notes are kepted in 
an Org file as the plain text database. This lets you easily manage your 
marginal notes and use the built-in Org fecilities on them -- e.g. create a 
sparse tree based on the category of the notes
-
-- Have the same highlighting and annotating functionality for websites when 
you use EWW to browse them (new in latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.)
-
-- Create your your own highlighter pens with different colors, type (e.g. 
underline, squiggle, etc. optionally with Org's category for search and filter 
on your highlights and notes)
 
 * Contributing and Feedback
 
@@ -92,14 +95,14 @@ Org-remark is available on GNU ELPA and thus copyrighted by 
the [[http://fsf.org
 Thank you.
 
 * Contributors
-** New features
+- New features ::
 - ~echo-text~ update from the marginal notes to the source buffer by marty 
hiatt (@mooseyboots)
 - Support for websites with ~eww-mode~ by Vedang Manerikar (@vedang)
 
-** Bug fixes:
+- Bug fixes ::
 Nan Jun Jie (@nanjj), @sgati-bodhi
 
-** Documentation (including README, NEWS, CHANGELOG):
+- Documentation (including README, NEWS, CHANGELOG) ::
 @randomwangran, marty hiatt (@mooseyboots)
 
 * License
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 64d951d0b9..f678730cf1 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -67,7 +67,7 @@ After installation, we suggest you put the setup below in 
your configuration.
 
 ~org-remark-global-tracking-mode~ automatically turns on ~org-remark-mode~ 
when you open a file or website via EWW [fn:1] that has a marginal notes file 
associated to it. This is useful to keep the location of your highlights 
correct across Emacs sessions after you shutdown Emacs.
 
-[fn:1]: Feature to highlight and annotate websites is new in latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.
+[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.
 
 Unless you explicitly load ~org~ during Emacs initialization, we suggest to 
defer loading ~org-remark~ (thus there is no ~(require 'org-remark)~ in the 
example above). This is because it will also pull in ~org~, which can slow down 
initialization. You can control the timing of loading ~org-remark~ by 
autoloading some commands in a similar way with the example keybindings below.