Add release documentation

master v0.1.0
Andrew 2022-05-14 00:15:15 +04:00
parent 8efc86279f
commit d5d8179383
Signed by: i
GPG Key ID: F7107F1C9D7B9981
3 changed files with 25 additions and 13 deletions

6
CHANGELOG.md Normal file
View File

@ -0,0 +1,6 @@
2022-05-13 Version 0.1.0
------------------------
- Add: creating checkboxes and radio buttons
- Add: toggle checkboxes and radio buttons
- Add: setting indents

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) <year> <copyright holders>
Copyright (c) 2022 Andrew Nechaev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

View File

@ -1,29 +1,35 @@
Vim Markdown
============
ftplugin для работы c markdown разметкой.
ftplugin to work with markdown.
Возможности
-----------
Features
--------
- Фолдинг и установка чекбоксов и радиокнопок
- Creating and toggle checkboxes and radio buttons
Установка
---------
Install
-------
```shell
mkdir ~/.vim/ftplugin
curl https://code.geekfrom.ru/i/vim-md/raw/branch/master/ftplugin/markdown.vim > ~/.vim/ftplufin/markdown.vim
curl https://code.geekfrom.ru/i/vim-md/raw/branch/master/ftplugin/markdown.vim > ~/.vim/ftplugin/markdown.vim
```
Mappings
--------
|description|modes|mapping|
|-----------|-----|-------|
|Установить/убрать радиокнопку|normal, visual|`<leader>r`|
|Установить/убрать чекбокс|normal, visual|`<leader>c`|
|Переключить чекбокс/радиокнопку|normal, visual|`<leader>t`|
| description | modes | mapping |
|------------------------------|----------------|-------------|
| Set/remove radio button | normal, visual | `<leader>r` |
| Set/remove checkbox | normal, visual | `<leader>c` |
| Toggle checkbox/radio button | normal, visual | `<leader>t` |
License
-------
MIT License. See `LICENSE` for more information.