Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: markdown rendering via glamour #13

Merged
merged 3 commits into from
Jul 22, 2024
Merged

feat: markdown rendering via glamour #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
505a246
feat: add md rendering via glamour
dhth Jul 22, 2024
09d3cdb
feat: make use of full width for context pane
dhth Jul 22, 2024
d501179
feat: render help using glamour
dhth Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 88 additions & 74 deletions cmd/guide.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import (
"github.com/dhth/omm/internal/types"
)

const (
codeBlockMarker = "```"
)

type entry struct {
summary string
ctx string
Expand All @@ -19,21 +23,21 @@ func insertGuideTasks(db *sql.DB) error {
var entries = []entry{
{
"guide: welcome to omm",
`Hi there 👋 Thanks for trying out omm.
fmt.Sprintf(`Hi there 👋 Thanks for trying out **omm**.

This is a guided walkthrough to get you acquainted with omm's features.

Before we begin, let's get the basics out of the way: you exit omm by pressing
q/esc/ctrl+c. These keys also move you back menus/panes whilst using omm's TUI.
%s. These keys also move you back menus/panes whilst using omm's TUI.

Onwards with the walkthrough then! Simply press j/↓, and follow the
Onwards with the walkthrough then! Simply press %s, and follow the
instructions.
`,
`, "`q/esc/<ctrl+c>`", "`j/↓`"),
true,
},
{
"domain: tasks",
`omm ("on-my-mind") is a task manager. You can also think of it as a keyboard
`omm (**on-my-mind**) is a task manager. You can also think of it as a keyboard
driven to-do list.

As such, tasks are at the core of omm. A task can be anything that you want to
Expand All @@ -48,176 +52,181 @@ you want to save details that don't fit in a single line.
},
{
"domain: task state",
`A task can be in one of two states: active or archived.
fmt.Sprintf(`A task can be in one of two states: **active** or **archived**.

This list shows active tasks.

To be pedantic about things, only the tasks in the active list are supposed to
be "on your mind". However, there are benefits to having a list of archived
tasks as well.

Press <tab> to see the archived list.
`,
Press %s to see the archived list.
`, "`<tab>`"),
true,
},
{
"domain: task details",
`The "Task Details" pane is intended for when you simply want to read all the
fmt.Sprintf(`The **Task Details** pane is intended for when you simply want to read all the
details associated with a task in a full screen view.

You can view this pane by pressing "d".
You can view this pane by pressing %s. This pane is useful when a task's
context is too long to fit in the context pane.

Whilst in this pane, you can move backwards and forwards in the
task list by pressing "h/<-/->/l". You quit out of this pane by either pressing
"d" again, or q/esc/ctrl+c.
task list by pressing %s. You quit out of this pane by either pressing
%s again, or %s.

Try it out. Come back to this entry when you're done.
`,
`, "`d`", "`h/<-/->/l`", "`d`", "`q/esc/<ctrl+c>`"),
dhth marked this conversation as resolved.
Show resolved Hide resolved
true,
},
{
"domain: an archived task",
`This is the archived list, meaning it holds tasks that are no longer being
worked on.
fmt.Sprintf(`This is the **Archived Tasks** list, meaning it holds tasks that are no longer
being worked on.

omm provides this list both for historical reference, as well as for you to be
able to move an archived task back into the active list.

You can toggle the state of a task using <ctrl+d>.
You can toggle the state of a task using %s.

Press tab/q/esc/ctrl+c to go back to the active list.
`,
Press %s to go back to the active list.
`, "`ctrl+d`", "`tab/q/esc/<ctrl+c>`"),
false,
},
{
"visuals: list density",
`omm's task lists can be viewed in two density modes: compact and spacious.
fmt.Sprintf(`omm's task lists can be viewed in two density modes: **compact** and **spacious**.

This is the compact mode. As opposed to this, the spacious mode shows tasks in a
more roomier list, alongside highlighting prefixes (we'll see what that means),
and showing creation timestamps.

omm starts up with spacious mode by default (you can change this, as we'll see
soon). You can toggle between the two modes by pressing "v". Choose whichever
soon). You can toggle between the two modes by pressing %s. Choose whichever
mode fits your workflow better.

Try it out. Come back to this mode once you're done.
`,
`, "`v`"),
true,
},
{
"visuals: toggling context pane",
`The context pane can be toggled on/off by pressing "C".
fmt.Sprintf(`The context pane can be toggled on/off by pressing %s.

You can choose to display it or not based on your preference. For convenience,
the lists will always highlight tasks that have a context associated with them
by having a "(c)" marker on them.
by having a **(c)** marker on them.

omm starts up with the context pane hidden by default (you can change this, as
we'll see soon).
`,
`, "`C`"),
true,
},
{
"actions: adding tasks",
`Let's get to the crux of omm: adding and prioritizing tasks. We'll
fmt.Sprintf(`Let's get to the crux of omm: **adding and prioritizing tasks**. We'll
begin with adding tasks.

You can add a task below the cursor by pressing "a". Once you get acquainted
You can add a task below the cursor by pressing %s. Once you get acquainted
with omm, you'll want to have more control on the position of the newly added
task. omm offers the following keymaps for that.

o/a add task below cursor
O add task above cursor
I add task at the top
A add task at the end
o/a add task below cursor
O add task above cursor
I add task at the top
A add task at the end

Go ahead, create a task, then move to the next guided item.
`,
`, "`a`"),
true,
},
{
"cli: adding a task via the CLI",
`You can also add a task to omm via its command line interface. For example:
fmt.Sprintf(`You can also add a task to omm via its command line interface. For example:

%sbash
omm 'prefix: a task summary'
%s

This will add an entry to the top of the active tasks list.
`,
`, codeBlockMarker, codeBlockMarker),
true,
},
{
"cli: importing several tasks via the CLI",
`You can also import more than one task at a time by using the "import"
fmt.Sprintf(`You can also import more than one task at a time by using the **"import"**
subcommand. For example:

%sbash
cat << 'EOF' | omm import
orders: order new ACME rocket skates
traps: draw fake tunnel on the canyon wall
tech: assemble ACME jet-propelled pogo stick
EOF
%s

omm will expect each line in stdin to hold one task's summary.
`,
`, codeBlockMarker, codeBlockMarker),
true,
},
{
"actions: adding context",
`As mentioned before, once a task is created, you might want to add context to
fmt.Sprintf(`As mentioned before, once a task is created, you might want to add context to
it.

You do that by pressing "c". Go ahead, try it out. Try changing the text, and
You do that by pressing %s. Go ahead, try it out. Try changing the text, and
then save the file. This context text should get updated accordingly.

Once saved, you can also copy a tasks's context to your system clipboard by pressing "y".
`,
Once saved, you can also copy a tasks's context to your system clipboard by pressing %s.
`, "`c`", "`y`"),
true,
},
{
"actions: filtering tasks",
`You can filter tasks in a list by pressing "/". Doing this will open up a search
fmt.Sprintf(`You can filter tasks in a list by pressing %s. Doing this will open up a search
prompt, which will match your query with task prefixes.

Try it out now. You get out of the filtered state by pressing "q/esc/ctrl+c".
Try it out now. You get out of the filtered state by pressing %s.

Note: You cannot add tasks or move them around in a filtered state. But, you can
move a task to the top of the list (by pressing ⏎). Doing this will also get you
move a task to the top of the list (by pressing %s). Doing this will also get you
out of the filtered state.
`,
`, "`/`", "`q/esc/<ctrl+c>`", "`⏎`"),
true,
},
{
"actions: quick filtering via a list",
`You can also choose the prefix you want to filter by with the means of a list,
hereby called as the "Quick Filter List". Press "ctrl+p" to open up a set of
task prefixes contained in the currently active task list. Press ⏎ to
fmt.Sprintf(`You can also choose the prefix you want to filter by with the means of a list,
hereby called as the **Quick Filter List**. Press %s to open up a set of
task prefixes contained in the currently active task list. Press %s to
pre-populate the task list's search prompt with your selection.

Try it out now.

Note: Both the "Active Tasks List" and "Archived Tasks List" can be filtered
separately, using either the manual filtering approach or via the "Quick Filter
List".
`,
Note: Both the **Active Tasks List** and **Archived Tasks List** can be filtered
separately, using either the manual filtering approach or via the **Quick Filter
List**.
`, "`ctrl+p`", "`⏎`"),
true,
},
{
"domain: task bookmarks",
`Sometimes you'll add URLs to a task's summary or its context.
fmt.Sprintf(`Sometimes you'll add URLs to a task's summary or its context.

Such URLs (eg. https://github.com/dhth/omm, https://tools.dhruvs.space,
https://c.xkcd.com/random/comic) could be placed anywhere in the summary/
context.

omm lets you open these URLs via a single keypress. You can either press "b" to
open up a list of all URLs, and then open one of them by pressing ⏎, or open all
of them by pressing "B".
omm lets you open these URLs via a single keypress. You can either press %s to
open up a list of all URLs, and then open one of them by pressing %s, or open all
of them by pressing %s.

Note: if the task has a single URL added to it, pressing "b" will skip showing
Note: if the task has a single URL added to it, pressing %s will skip showing
the list, and open the URL directly.

Try both approaches now. Press "b", interact with the list, and then press "B".
`,
Try both approaches now.
`, "`b`", "`⏎`", "`B`", "`b`"),
true,
},
{
Expand All @@ -229,9 +238,9 @@ And, as we all know, priorities often change. You're probably juggling multiple
tasks on any given day. As such, omm allows you to move tasks around in the
priority order. It has the following keymaps to achieve this:

⏎ move task to the top
J move task one position down
K move task one position up
⏎ move task to the top
J move task one position down
K move task one position up

It's recommended that you move the task that you're currently focussing on to
the top.
Expand All @@ -240,52 +249,57 @@ the top.
},
{
"actions: updating task details",
`Once a task is created, its summary and context can be changed at any point.
fmt.Sprintf(`Once a task is created, its summary and context can be changed at any point.

You can update a task's summary by pressing "u".
You can update a task's summary by pressing %s.

This will open up the the same prompt you saw when creating a new task, with the
only difference that the task's summary will be pre-filled for you. This can
come in handy when you want to quickly jot down a task for yourself (either by
using the TUI, or by using the CLI (eg. "omm 'a hastily written task summary")),
using the TUI, or by using the CLI (eg. %s)),
and then come back to it later to refine it more.

Similarly, you can also update a task's context any time (by pressing "c").
`,
Similarly, you can also update a task's context any time (by pressing %s).
`, "`u`", "`omm 'a hastily written task summary'`", "`c`"),
true,
},
{
"config: changing the defaults",
`omm allows you to change the some of its behavior via configuration, which it
fmt.Sprintf(`omm allows you to change the some of its behavior via configuration, which it
will consider in the order listed below:

- CLI flags (run "omm -h" to see details)
- Environment variables (eg. "OMM_EDITOR")
- A TOML configuration file (run "omm -h" to see where this lives; you can
change this via the flag "--config-path")
- CLI flags (run %s to see details)
- Environment variables (eg. %s)
- A TOML configuration file (run %s to see where this lives; you can
change this via the flag %s)

omm will consider configuration in the order laid out above, ie, CLI flags will
take the highest priority.
`,
`, "`omm -h`", "`$OMM_EDITOR`", "`omm -h`", "`--config-path`"),
true,
},
{
"config: flags, env vars, and config file",
`Every flag listed by "omm -h" (except "--config-path") has an environment
fmt.Sprintf(`Every flag listed by %s (except %s) has an environment
variable counterpart, as well as a TOML config counterpart.

For example:

%stext
--show-context -> OMM_SHOW_CONTEXT -> show_context
--editor -> OMM_EDITOR -> editor
`,
%s
`, "`omm -h`", "`--config-path`", codeBlockMarker, codeBlockMarker),
true,
},
{
"config: a sample TOML config",
fmt.Sprintf(`Here's a sample TOML configuration file:

%s`, sampleCfg),
%stoml
%s
%s
`, codeBlockMarker, sampleCfg, codeBlockMarker),
true,
},
{
Expand Down
Loading