https://github.com/revolter/obsidian-track-a-lot-plugin

This is a tracker plugin for Obsidian
https://github.com/revolter/obsidian-track-a-lot-plugin

obsidian obsidian-plugin plugin

Last synced: 4 months ago
JSON representation

This is a tracker plugin for Obsidian

• Host: GitHub
• URL: https://github.com/revolter/obsidian-track-a-lot-plugin
• Owner: revolter
• License: mit
• Created: 2024-02-18T12:11:09.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-26T18:03:29.000Z (9 months ago)
• Last Synced: 2025-01-02T03:51:57.603Z (4 months ago)
• Topics: obsidian, obsidian-plugin, plugin
• Language: TypeScript
• Homepage: https://obsidian.md/plugins?id=track-a-lot
• Size: 619 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - revolter/obsidian-track-a-lot-plugin - This is a tracker plugin for Obsidian (TypeScript)

README

        
# Obsidian Track-a-Lot Plugin

![Obsidian plugin downloads badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fscambier.xyz%2Fobsidian-endpoints%2Ftrack-a-lot.json)

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](images/screenshot.png)

## 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](../../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

   ```sh

   npm install

   ```

### Usage

```sh

npm run dev

```

### Releasing

1. Run `npm version `.

2. Optionally add release notes to the created GitHub draft release.

3. Publish the GitHub draft release.

### Submitting

1. Follow the [official instructions](https://docs.obsidian.md/Plugins/Releasing/Submit+your+plugin#Step+3+Submit+your+plugin+for+review).

## License

[MIT](LICENSE)