/weekly

The overview of your stuff in a week

Primary LanguageSCSSMIT LicenseMIT

⚠️ This project has been archived. Please check out the version 2 here

Weekly

It's a methodology to keep track of your stuff like tasks, events, notes by creating the bullets. I found that I love this method and easily adapt to it than other tools that I've tried like Trello, note-taking apps, to-do apps.

demo

Usage

[ ] Open
[@] Ongoing
[x] Completed
[~] Obsolete

^ an event.

## A bullet list

- Item 1
- Item 2

## An ordered list

1. First
2. Second
3. And the final

Let's create a @tag

Prioritize your task using !low !medium !high

## You can use common markdown's syntax like:

**bold**
_italic_
~~strike through~~
`code`

Contribute

I'd like to appreciate your contributions to improve the project better. Here are some steps to start your contribution:

# Project setup

pnpm install

# Start development

pnpm dev

# Compiles and minifies for production

pnpm build

# Lints, formats and fixes files

pnpm format
pnpm lint
pnpm stylelint

Thanks

  • I was inspired by the original one here bastianallgeier/bulletjournal
  • Don't forget to give a shout out to @huytd with his amazing project markd.one. I've made some regex preferences from his project.

License

MIT © Thien Nguyen