Version bump, updates documentation for -e

d0c-s4vage · Oct 22, 2020 · 655a755 · 655a755
1 parent b2cd753
commit 655a755
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,16 @@
 - [v0.2.0](#v020)
 - [v0.1.0](#v010)
 
+## v2.2.0
+
+Removes copyrighted image, adds `-e` and `--exts` options
+
+|    type | ticket                                                    | description                         |
+|--------:|-----------------------------------------------------------|-------------------------------------|
+| feature | [#103](https://github.com/d0c-s4vage/lookatme/issues/103) | Adds ability to pre-load extensions |
+|     bug | [#107](https://github.com/d0c-s4vage/lookatme/issues/107) | Removes copyrighted image           |
+
+
 ## v2.1.0
 
 Adds customizable slide margins and paddings

diff --git a/README.md b/README.md
@@ -74,6 +74,9 @@ Options:
   --live, --live-reload           Watch the input filename for modifications
                                   and automatically reload
 
+  -e, --exts TEXT                 A comma-separated list of extension names to
+                                  automatically load (LOOKATME_EXTS)
+
   --single, --one                 Render the source as a single slide
   --version                       Show the version and exit.
   --help                          Show this message and exit.

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -20,24 +20,27 @@ The ``lookatme`` CLI has a few options to control it's behavior:
 
 .. code-block:: text
 
-   Usage: lookatme [OPTIONS] [INPUT_FILES]...
+    Usage: lookatme [OPTIONS] [INPUT_FILES]...
 
-     lookatme - An interactive, terminal-based markdown presentation tool.
+      lookatme - An interactive, terminal-based markdown presentation tool.
 
-   Options:
-     --debug
-     -l, --log PATH
-     -t, --theme [dark|light]
-     -s, --style [default|emacs|friendly|colorful|autumn|murphy|manni|monokai|perldoc|pastie|borland|trac|native|fruity|bw|vim|vs|tango|rrt|xcode|igor|paraiso-light|paraiso-dark|lovelace|algol|algol_nu|arduino|rainbow_dash|abap|solarized-dark|solarized-light|sas|stata|stata-light|stata-dark|inkpot]
-     --dump-styles                   Dump the resolved styles that will be used
-                                     with the presentation to stdout
+    Options:
+      --debug
+      -l, --log PATH
+      -t, --theme [dark|light]
+      -s, --style [default|emacs|friendly|colorful|autumn|murphy|manni|monokai|perldoc|pastie|borland|trac|native|fruity|bw|vim|vs|tango|rrt|xcode|igor|paraiso-light|paraiso-dark|lovelace|algol|algol_nu|arduino|rainbow_dash|abap|solarized-dark|solarized-light|sas|stata|stata-light|stata-dark|inkpot]
+      --dump-styles                   Dump the resolved styles that will be used
+                                      with the presentation to stdout
 
-     --live, --live-reload           Watch the input filename for modifications
-                                     and automatically reload
+      --live, --live-reload           Watch the input filename for modifications
+                                      and automatically reload
 
-     --single, --one                 Render the source as a single slide
-     --version                       Show the version and exit.
-     --help                          Show this message and exit.
+      -e, --exts TEXT                 A comma-separated list of extension names to
+                                      automatically load (LOOKATME_EXTS)
+
+      --single, --one                 Render the source as a single slide
+      --version                       Show the version and exit.
+      --help                          Show this message and exit.
 
 ``--live`` / ``--live-reload``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -54,8 +57,15 @@ are possible:
   :width: 800
   :alt: Live Updates
 
+``-e EXT_NAME1,EXT_NAME2`` / ``--exts EXT_NAME1,EXT_NAME2``
+^^^^^^^^^^^^^^^^^^^
+
+Allows a comma-separated list of extension names to be pre-loaded into lookatme
+without requring them to be declared in the Markdown source.
+
+
 ``--single`` / ``--one``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 Render the markdown source as a single slide, ignoring all hrules. Scroll
 overflowing slides with the up/down arrow keys and page up/page down.