GitXplorerGitXplorer
r

obsidian-track-a-lot-plugin

public
11 stars
0 forks
1 issues

Commits

List of commits on branch master.
Verified
16cd90e9e4ad190144e261d1af6611a01a21dd3d

Project: Automated the branch and tag push steps

rrevolter committed 6 months ago
Verified
8642fc8540b48a6d970adbc4264950ef1518718a

Docs: Added missing branch push step to the releasing instructions

rrevolter committed 6 months ago
Verified
d8ec87a135c6a69ca1b16be9b658e6ee79cef1ce

Project: Updated the description according to the guidelines

rrevolter committed 6 months ago
Verified
6786469a7ecd6203941c3e9cb24442ecaf53adb7

Docs: Added submitting instructions

rrevolter committed 6 months ago
Verified
49f3a22f6cfed6a2990a9b741a0d688cf1612cee

Docs: Added missing tag push step to the releasing instructions

rrevolter committed 6 months ago
Verified
de82412b9cc49272072644cc90b2734d57d69e1b

Docs: Added setup instructions

rrevolter committed 6 months ago

README

The README file for this repository.

Obsidian Track-a-Lot Plugin

Obsidian plugin downloads badge

This is a tracker plugin for Obsidian (https://obsidian.md).

It scrapes different webpages, builds lists with the items, and allows you to individually track their status.

The lists are created as Markdown tables. You can write anything in the status column, and it will be preserved when you update the list.

screenshot

Settings

  1. Open Settings > Track-a-Lot.
  2. Enable the required tracking recipe.

Usage

  1. Create or select a note.
  2. Make sure the note is in editing mode (https://help.obsidian.md/Editing+and+formatting/Edit+and+preview+Markdown).
  3. Open the Command palette (https://help.obsidian.md/Plugins/Command+palette).
  4. Search for the Track-a-Lot command for the respective list (e.g. Track-a-Lot: Update Hanayama Huzzles list).
  5. Press Enter.

Contributing

Setup

  1. Go to settings/actions.
  2. Enable Read and write permissions under Workflow permissions.
  3. Click Save.

Installation

  1. Install Node.js by following the instructions from https://docs.npmjs.com/downloading-and-installing-node-js-and-npm.
  2. Install the Node.js dependencies by running
    npm install

Usage

npm run dev

Releasing

  1. Run npm version <major/minor/patch>.
  2. Optionally add release notes to the created GitHub draft release.
  3. Publish the GitHub draft release.

Submitting

  1. Follow the official instructions.

License

MIT