search

d0c-s4vage / lookatme

An interactive, terminal-based markdown presenter
https://lookatme.readthedocs.io/en/latest/
MIT License
2.08k stars 61 forks source link

Adds tutorials! #172

Closed d0c-s4vage closed 1 year ago

d0c-s4vage commented 1 year ago

Really happy with how this is turning out!

Fixes #169

d0c-s4vage commented 1 year ago

Example usage:

$> lookatme --help
Usage: lookatme [OPTIONS] [INPUT_FILES]...

  lookatme - An interactive, terminal-based markdown presentation tool.

  See https://lookatme.readthedocs.io/en/v{{VERSION}} for documentation

Options:
  --debug
  -l, --log PATH
  --tutorial TEXT                 As a flag: show all tutorials. With a
                                  value/comma-separated values: show the
                                  specific tutorials. Use the value 'help' for
                                  more help
  -t, --theme [dark|light]
  --style [default|emacs|friendly|friendly_grayscale|colorful|autumn|murphy|manni|material|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|staroffice|stata|stata-light|stata-dark|inkpot|zenburn|gruvbox-dark|gruvbox-light|dracula|one-dark|lilypond|nord|nord-darker|github-dark]
  --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
  -s, --safe                      Do not load any new extensions specified in
                                  the source markdown. Extensions specified
                                  via env var or -e are still loaded
  --no-ext-warn                   Load new extensions specified in the source
                                  markdown without warning
  -i, --ignore-ext-failure        Ignore load failures of extensions
  -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.
$> lookatme --tutorial help
Help for 'lookatme --tutorial'

Specific tutorials can be run with a comma-separated list of group or
tutorial names. Below are the groups and tutorial names currently defined.

  markdown
    images
    links
    emphasis
    double emphasis
    inline code
    strikethrough
    headings
    tables
    lists
    unordered lists
    ordered lists
    paragraph
    block quote
    code blocks
  general
    intro
    title
    slides splitting
    metadata
    markdown supported features

Substring matching is used to identify tutorials and groups. All matching
tutorials and groups are then run.

Examples:
    lookatme --tutorial
    lookatme --tutorial link,table
    lookatme --tutorial general,list
d0c-s4vage commented 1 year ago

Need at least some tests for this