Skip to content

For lovers of the analog Bullet Journal, but in markdown. Custom CSS to add Bullet Journal Rapid Logging to the markdown editor Typora. Use with your favourite Typora theme.

Notifications You must be signed in to change notification settings

kathyavini/Typora-Rapid-Logging

Repository files navigation

Typora Rapid Logging

CSS to style unordered lists and task lists according to the original Bullet Journal rapid logging marks.

Created and tested on MacOS 10.14.6 (Mojave)


Preview

Solarized
Solarized Dark
Mint
Vue Dark

Theme Credits

All credit for these beautiful themes go to their authors:

[Mint] [Lavender] [Vue] [Solarized]

And the completed task bullet strikethrough animation was adapted from the awesome theme Ursine.


Project Background

Why this project

I wanted to Bullet Journal in markdown (for speed, searachability, space) without losing the spirit or simplicity of the analog system. I wasn't looking for task management or scheduling, I just wanted to make daily logs and rapid log -- but in markdown!

Typora's live rendering of markdown is beautiful and functional. I was curious if it could be tweaked for rapid logging with some custom CSS.

Details

Unordered Lists in Markdown

In straight markdown rapid logging is simple:

- you could use a dash for a note
* Asterisk for event circle
+ And plus for a longform note

(Although you would have difficulty using the > to forward tasks, as it starts a blockquote, and tasks could only be checkboxes, not bullets.)

In rendered markdown, including GitHub flavored markdown, all bullet types are rendered equivalently:

  • you could use a dash for a note
  • Asterisk for event circle
  • And plus for a longform note

... but they would all look the same.

Luckily in Typora the original bullet type is kept in the "data-mark" attribute which can be accessed through CSS.

Tasks

Data-marks can't be used to give extra styling to tasks (the forwarding/scheduling of rapid logging), because all tasks have the standard markdown format -[x]. In any case I didn't want to adopt a method that would generate a task list unrecognizable to other markdown editors.

Therefore I picked tab indent as the easiest way to modify a task to schedule/forward it. It's not a perfect solution because subtasks are also very useful. As described below in Subtasks/Task Nesting, feel free to turn off the forwarding/scheduling marks in order to use subtasks.

Result

Put together, Typora Rapid Logging takes this unstyled markdown:

# Rapid Logging in Typora
## Lavender Theme

- This is a note (dash)
* This is an event; start the line with an * (asterisk) bullet to render a circle
  - You can nest notes under events, events under notes, etc.
* [ ] This is a task. It's a normal markdown checkbox styled as a task bullet
* [ ] View it in another theme/editor and it will still be a checkbox
* [x] Completed tasks are in the bullet journal style
* [x] (Plus a nice strikethrough effect, which isn't technically in the Bullet Journal style)
  * [ ] Indent your task once to forward it
  * [x] Check off (complete) your forwarded task to scheduled it
  * [ ] Helpful hover animations indicate a task whose checked state can be toggled

And renders it like this:


Installation

Instructions

Download the {theme-name}.user.css file for the theme that you want to use with rapid logging, and move it into your Typora themes folder. You can find a link to this folder under Preferences > Appearance.

For more on how custom CSS works in Typora see Add Custom CSS in the Typora documentation.

Using with other themes

Using with other themes

These CSS files only style unordered lists and no other elements (fonts, colors, spacing) so they can work with any number of your existing Typora themes. Modify template-base-user.css if you'd like to adapt it to one of the themes not included in this repository and rename it to {theme-name}.user.css. I've included (hopefully) helpful comments and variables at the top of that file to help you match up the CSS to the look of the theme you are modifying.


Notes on Nesting and Newlines

Subtasks/Task Nesting

Subtasks vs. Forwarding/Scheduling Task Bullets

Typora Rapid Logging makes use of indentation (tabbing) as the easiest way to forward and schedule tasks bullets.

If you would prefer to nest your bullets (use subtasks) instead, disable forwarding and scheduling by commenting out the code indicated at the end of the .css file:

Doing so won't affect the rest of the rapid logging marks or styles.

A Note about Newlines

Newlines in the markdown

One quirk of how Typora generates markdown in its hybrid view is that it will insert a newline when you tab all the way out and begin a list item with a different mark. This isn't visible in hybrid view, only in the markdown:

- This is a note (dash)

* This is an event; start the line with an * (asterisk) bullet to render a circle

  - You can nest notes

* [ ] This is a task

This can't be adjusted in preferences. Therefore, if you are using your rapid logging to switch often between notes, events, and tasks, I would recommend opening up source code mode with COMMAND + /(MacOS) or Ctrl + / (Windows/Linux) to make your list items:

As far as I know, writing in source code mode is the only way to suppress the automatically generated newline.

This extra newline issue doesn't affect markdown created in other editors and viewed in Typora.

About

For lovers of the analog Bullet Journal, but in markdown. Custom CSS to add Bullet Journal Rapid Logging to the markdown editor Typora. Use with your favourite Typora theme.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages