[bot] "documentation_updates" Sat Sep 11 22:58:39 UTC 2021

dalanicolai · Sep 11, 2021 · 663cfc5 · 663cfc5
1 parent 7f00715
commit 663cfc5
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 38 deletions.
diff --git a/layers/+readers/djvu/README.org b/layers/+readers/djvu/README.org
@@ -1,10 +1,10 @@
 #+TITLE: djvu layer
+
 #+TAGS: layer|reader
 
-#+CAPTION: source: https://commons.wikimedia.org/wiki/File:DjVu-logo.svg
 [[file:img/djvu-logo.svg]]
 
-* Table of Contents                                        :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
@@ -25,7 +25,6 @@ Because of some difficulties, the layer does not lazy load the =djvu.el= and
 ** Features:
 This layer provides a full featured djvu editor by implementing the [[https://github.com/dalanicolai/djvu2.el][djvu.el
 package]] along with the [[https://github.com/dalanicolai/djvu3][djvu3]] extension (a newer alternative to [[https://github.com/dalanicolai/djvu2.el][djvu2.el]]).
-
 - flexible annotation editing and rendering, covering most (but not all) of
   [[https://linux.die.net/man/1/djvused][djvused]] annotation definitions
 - fast navigation with imenu
@@ -40,19 +39,18 @@ available in =exec-path=.
 
 Additionally, for =dark-mode= the command =pnminvert= (from
 [[http://netpbm.sourceforge.net/][netpbm]]) is required.
-  
+
 ** Dotfile
 After installing the dependencies, add this to your ~/.spacemacs.
 
 #+BEGIN_SRC emacs-lisp
-    (setq-default dotspacemacs-configuration-layers '(djvu))
+  (setq-default dotspacemacs-configuration-layers '(djvu))
 #+END_SRC
 
 * Key bindings
-
 ** djvu-read-mode
 
-| Key Binding | Description                                                                      |
+| Key binding | Description                                                                      |
 |-------------+----------------------------------------------------------------------------------|
 | ~i~         | djvu-image-toggle                                                                |
 | ~j~         | scroll up                                                                        |
@@ -71,26 +69,26 @@ After installing the dependencies, add this to your ~/.spacemacs.
 
 ** Annotations
 
-| Key Binding        | Description                                            |
-|--------------------+--------------------------------------------------------|
-| ~SPC m h~          | keyboard highlight                                     |
-| ~mouse-1-drag~     | highlight                                              |
-| ~S-mouse-1-drag~   | text annotation ([[https://github.com/dalanicolai/djvu3#comments][comment]])                              |
-| ~C-mouse-1-drag~   | text pushpin (rendering pushpin not yet implemented)   |
-| ~mouse-2-drag~     | line                                                   |
-| ~S-mouse-2-drag~   | horizontal line                                        |
-| ~C-mouse-2-drag~   | vertical line                                          |
-| ~C-S-mouse-2-drag~ | arrow                                                  |
+| Key binding        | Description                                          |
+|--------------------+------------------------------------------------------|
+| ~SPC m h~          | keyboard highlight                                   |
+| ~mouse-1-drag~     | highlight                                            |
+| ~S-mouse-1-drag~   | text annotation ([[https://github.com/dalanicolai/djvu3#comments][comment]])                            |
+| ~C-mouse-1-drag~   | text pushpin (rendering pushpin not yet implemented) |
+| ~mouse-2-drag~     | line                                                 |
+| ~S-mouse-2-drag~   | horizontal line                                      |
+| ~C-mouse-2-drag~   | vertical line                                        |
+| ~C-S-mouse-2-drag~ | arrow                                                |
 
 ** djvu-image-minor-mode
 
-| Key Binding | Description |
+| Key binding | Description |
 |-------------+-------------|
 | ~s~         | save-image  |
 
 ** djvu-occur-mode
 
-| Key Binding | Description               |
+| Key binding | Description               |
 |-------------+---------------------------|
 | ~C-j~       | next entry and follow     |
 | ~C-k~       | prevoius entry and follow |
diff --git a/layers/+web-services/hackernews/README.org b/layers/+web-services/hackernews/README.org
@@ -1,7 +1,8 @@
 #+TITLE: Hacker News layer
+
 #+TAGS: layer|web service
 
-* Table of Contents                                       :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
@@ -12,7 +13,7 @@
 This layer adds support for reading [[https://news.ycombinator.com/][Hacker News]].
 
 ** Features:
-  - Read Hacker News
+- Read Hacker News
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@@ -21,13 +22,13 @@ file.
 
 * Key bindings
 
-| Key Binding | Description |
+| Key binding | Description |
 |-------------+-------------|
 | ~SPC a w h~ | hackernews  |
 
 ** Major mode key bindings
 
-| Key Binding | Description                                  |
+| Key binding | Description                                  |
 |-------------+----------------------------------------------|
 | ~RET~       | Open link in default (external) browser      |
 | ~t~         | Open link in text-based browser within Emacs |

diff --git a/layers/+web-services/lobsters/README.org b/layers/+web-services/lobsters/README.org
@@ -1,7 +1,8 @@
 #+TITLE: lobsters layer
+
 #+TAGS: layer|web service
 
-* Table of Contents                                       :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
@@ -11,7 +12,7 @@
 This layer adds support for reading [[https://lobste.rs/][lobsters]].
 
 ** Features:
-  - Read Lobsters news
+- Read Lobsters news
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@@ -20,6 +21,6 @@ file.
 
 * Key bindings
 
-| Key Binding | Description                        |
-|-------------+------------------------------------|
-| ~SPC a w l~ | ~helm-lobsters~  or ~ivy-lobsters~ |
+| Key binding | Description                       |
+|-------------+-----------------------------------|
+| ~SPC a w l~ | ~helm-lobsters~ or ~ivy-lobsters~ |
diff --git a/layers/+web-services/streamlink/README.org b/layers/+web-services/streamlink/README.org
@@ -2,7 +2,7 @@
 
 #+TAGS: layer|web service
 
-* Table of Contents                                       :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
@@ -12,7 +12,7 @@
 This layer adds support for opening URLs in streamlink. 
 
 ** Features:
-  - Open URL with streamlink
+- Open URL with streamlink
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@@ -21,6 +21,6 @@ file.
 
 * Key bindings
 
-| Key Binding   | Description              |
+| Key binding   | Description              |
 |---------------+--------------------------|
 | ~SPC a w s s~ | Open URL with streamlink |
diff --git a/layers/+web-services/twitch/README.org b/layers/+web-services/twitch/README.org
@@ -1,7 +1,8 @@
 #+TITLE: twitch layer
+
 #+TAGS: layer|web service
 
-* Table of Contents                                       :TOC_4_gh:noexport:
+* Table of Contents                     :TOC_5_gh:noexport:
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
@@ -14,9 +15,9 @@ This layer adds support for twitch. You can search for streamers and open the st
 You are also able to connect to twitch irc and join the streamer channel.
 
 ** Features:
-  - Connect to Twitch irc via erc
-  - Join streamer channel
-  - Start watching stream via streamlink
+- Connect to Twitch irc via erc
+- Join streamer channel
+- Start watching stream via streamlink
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@@ -35,14 +36,14 @@ You can get an OAUTH token for twitch [[http://twitchapps.com/tmi/][here]]. Remo
 
 * Key bindings
 
-| Key Binding   | Description                              |
+| Key binding   | Description                              |
 |---------------+------------------------------------------|
 | ~SPC a c i t~ | Connect to Twitch irc via erc            |
 | ~SPC a w s t~ | Start twitch helm and search for streams |
 
 ** Twitch helm
-   
-| Key Binding   | Description                             |
+
+| Key binding   | Description                             |
 |---------------+-----------------------------------------|
 | ~F1~ or ~RET~ | Open stream in streamlink               |
 | ~F2~          | Join this stream in irc Twitch channel  |

diff --git a/layers/LAYERS.org b/layers/LAYERS.org
@@ -181,6 +181,7 @@
 - [[#readers][Readers]]
   - [[#dash][Dash]]
   - [[#deft][Deft]]
+  - [[#djvu][Djvu]]
   - [[#elfeed][Elfeed]]
   - [[#epub][Epub]]
   - [[#pdf][PDF]]
@@ -257,9 +258,13 @@
   - [[#confluence][Confluence]]
   - [[#eaf][Eaf]]
   - [[#evernote][Evernote]]
+  - [[#hacker-news][Hacker News]]
   - [[#layer-for-reddit][Layer for reddit]]
+  - [[#lobsters][Lobsters]]
   - [[#pocket][Pocket]]
   - [[#search-engine][Search Engine]]
+  - [[#streamlink][Streamlink]]
+  - [[#twitch][Twitch]]
   - [[#twitter][Twitter]]
   - [[#wakatime][Wakatime]]
 
@@ -2429,6 +2434,25 @@ Features:
 - Configurable list of extensions to recognize as notes.
 - Zettelkasten system with [[https://github.com/EFLS/zetteldeft][zetteldeft]]
 
+** Djvu
+[[file:+readers/djvu/README.org][+readers/djvu/README.org]]
+
+This layer adds support for reading djvu files with spacemacs.
+
+Because of some difficulties, the layer does not lazy load the =djvu.el= and
+=djvu3.el= packages.
+
+Features:
+
+This layer provides a full featured djvu editor by implementing the [[https://github.com/dalanicolai/djvu2.el][djvu.el
+package]] along with the [[https://github.com/dalanicolai/djvu3][djvu3]] extension (a newer alternative to [[https://github.com/dalanicolai/djvu2.el][djvu2.el]]).
+- flexible annotation editing and rendering, covering most (but not all) of
+  [[https://linux.die.net/man/1/djvused][djvused]] annotation definitions
+- fast navigation with imenu
+- fast search with djvu-occur
+- remember last view with djvu-restore
+- dark mode
+
 ** Elfeed
 [[file:+readers/elfeed/README.org][+readers/elfeed/README.org]]
 
@@ -3269,6 +3293,14 @@ Features:
 - Search for notes using keywords
 - Move notes between notebooks
 
+** Hacker News
+[[file:+web-services/hackernews/README.org][+web-services/hackernews/README.org]]
+
+This layer adds support for reading [[https://news.ycombinator.com/][Hacker News]].
+
+Features:
+- Read Hacker News
+
 ** Layer for reddit
 [[file:+web-services/reddit/README.org][+web-services/reddit/README.org]]
 
@@ -3281,6 +3313,14 @@ Features:
   - Viewing sub
   - Viewing comments
 
+** Lobsters
+[[file:+web-services/lobsters/README.org][+web-services/lobsters/README.org]]
+
+This layer adds support for reading [[https://lobste.rs/][lobsters]].
+
+Features:
+- Read Lobsters news
+
 ** Pocket
 [[file:+web-services/pocket/README.org][+web-services/pocket/README.org]]
 
@@ -3302,6 +3342,25 @@ This layer adds support for the [[https://github.com/hrs/engine-mode][Search Eng
 Features:
 - Browser search integration
 
+** Streamlink
+[[file:+web-services/streamlink/README.org][+web-services/streamlink/README.org]]
+
+This layer adds support for opening URLs in streamlink.
+
+Features:
+- Open URL with streamlink
+
+** Twitch
+[[file:+web-services/twitch/README.org][+web-services/twitch/README.org]]
+
+This layer adds support for twitch. You can search for streamers and open the stream in the browser.
+You are also able to connect to twitch irc and join the streamer channel.
+
+Features:
+- Connect to Twitch irc via erc
+- Join streamer channel
+- Start watching stream via streamlink
+
 ** Twitter
 [[file:+web-services/twitter/README.org][+web-services/twitter/README.org]]