Skip to content

Commit

Permalink
0.1.0 Kata release
Browse files Browse the repository at this point in the history
  • Loading branch information
Atarity committed Nov 3, 2020
1 parent e6716ff commit 4dcd5e7
Show file tree
Hide file tree
Showing 19 changed files with 35 additions and 28 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
out
node_modules
builds
.vscode-test/
.vscode/settings.json
*.log
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Check: [List of generators](https://github.com/myles/awesome-static-generators)
- Request: add job for jekyll site compilation from a notes

## [0.1.0] — 2020-10-29
### Added
- H1 header will be added automatically on new note according filename
- Tags filtering sort lists by date now
- Todomator is Kata now!

## [0.0.11] — 2019-09-07
### Added
- Tags autocompletion added. With Unicode support.
Expand Down
45 changes: 20 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
# Kata VS Code extension
![kata logo](./meta/kata-logo.jpg)

Kata is a simple automator for everyday note taking needs. Each note entry:
- Saved in .md file with name like ```2018-06-13-todo.md```
- Have an YAML meta data at the beggining of a file. It contains "Title" and "Tags" sections with autocompleteon.
Kata is a simple automator for everyday note taking and journaling.

Each note entry:
- Saved in .md file with name in date-name form like a ```2018-06-13-todo.md```
- Have an YAML meta data at the top of a file. It contains "Title" and "Tags" sections with autocompletion and can be extended.

![create note](./meta/create-note.gif)

## 🦄 Features
- Automatic file naming and meta data addition
- Hotkey for todo state cycling
- Automatic file naming and meta on new note (<kbd>Ctrl</kbd>+<kbd>T</kbd>)
- Hotkey for todo state cycling (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd>)
- Notes filtering by tags (<kbd>F1</kbd> → `Kata: Filter notes by tag`)
- Brief statistics (<kbd>F1</kbd> → `Kata: Show statistics`)
- Tags autocompletion (<kbd>Ctrl</kbd>+<kbd>Space</kbd>)
- Nested todos
- Tags autocompletion for notes
- Notes filtering by tags
- Brief statistics
- Old-fashioned cloud sync
- Grammar injection for wider theme options (you could dim closed tasks)
- Works with old-fashioned cloud sync and git
- Grammar injection for theming (closed tasks dimming)
- All your files and notes are only yours.

## 🎮 How to install and use
1. Open folder with your Notes or create new folder then open it from VS Code as a folder.
1. Create empty file named `.Kata` and put it to your Notes folder.
1. Open VS Code. From F1 menu Run `>Extensions: Install from VSIX...`. Point to the Kata extension file with .vsix extension.
1. Open folder with your notes or create a new one. Then open it from VS Code **as a folder**.
1. Create empty file named `.kata` and put it to notes folder.
1. Open VS Code. Hit <kbd>F1</kbd> → run `>Extensions: Install from VSIX...`. Point to the Kata extension file with .vsix extension.
1. Press <kbd>Ctrl</kbd>+<kbd>T</kbd> to create new note file. A name could be corrected before confirmation.
1. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd> to create new todo entry in file.
1. Fill free to use all Markdown capabilities in your notes.

## 🔧 Extension Settings
This extension contributes the following settings:

* `kata.strikethruOnDone`: If enabled all closed tasks will wrapped in `~~` so it will be ~~stroke~~ during rendering.
* `kata.strikethruOnDone`: If enabled all closed tasks will wrapped in `~~` so it will be ~~stroke~~ during rendering depending on theme.

## 🐛 Known Issues
It's a proto, so most of exceptions not even tried to be caught.

## 🆕 Release notes
You can find detailed release notes in `Changelog.md`

## 📦 Packaging for off-the-Marketplace distribution
- `npm install` and `npm install -g vsce`
- `npm run compile`
- `vsce package`
- [VS code tut on packaging and publishing](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions)
It's a preview, so most of exceptions not even tried to be caught.
Binary file removed VSIX builds/tdm-0.0.1.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.10.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.11.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.12.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.2.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.3.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.4.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.5.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.6.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.7.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.8.vsix
Binary file not shown.
Binary file removed VSIX builds/tdm-0.0.9.vsix
Binary file not shown.
Binary file added meta/create-note.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added meta/kata-logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions meta/readme.dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 📦 Packaging for off-the-Marketplace distribution
- `npm install` and `npm install -g vsce`
- `npm run compile`
- `vsce package`
- [VS code tut on packaging and publishing](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions)
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "kata",
"displayName": "Kata",
"description": "Bore-friendly notetaking automator and parser.",
"version": "0.0.12",
"description": "Simple automator for everyday note taking and journaling.",
"version": "0.1.0",
"repository": {
"type": "git",
"url": "https://github.com/Atarity/Todomator.git"
"url": "https://github.com/Atarity/Kata.git"
},
"publisher": "Atarity",
"engines": {
Expand Down

0 comments on commit 4dcd5e7

Please sign in to comment.