Skip to main content

Personal knowledge storage formatter

Project description

Minimus

Инструмент для ведения заметок. Если у вас есть каталог с записями, minimus поможет сшить документы между собой с помощью тегов. А ещё он сделает стартовую страницу, с которой можно будет перейти на любой документ.

Как пользоваться

Надо иметь на машине установленный python версией 3.10 или новее.

Установка Минимуса:

pip install minimus

После этого можно перейти в корневой каталог с заметками и вызвать minimus в терминале:

minimus

Или:

min

Или:

minimus .

Можно также никуда не переходить и сообщить программе целевой каталог:

minimus "C:\\Заметки"

Требования к заметкам

Заметки должны быть в формате ".md", а теги надо отмечать двойными фигурными скобками. Программа заменит их ссылками на соответствующие файлы. Теги можно располагать где угодно в тексте. Следите только за тем, чтобы написание было всегда одинаковым.

До использования:

# Мышь

Маленькое млекопитающее.

---

Теги:

- {{ Хвост }}
- {{ 4 лапы }}
- {{ Серый }}

---

Живёт почти везде.

После:

# Мышь

Маленькое млекопитающее.

---

Теги:

- [{{ Хвост }}](../_tags/hvost.md)
- [{{ 4 лапы }}](../_tags/4_lapi.md)
- [{{ Серый }}](../_tags/seriy.md)

---

Живёт почти везде.

Нормальный вывод программы выглядит примерно вот так:

-------------------------------------------------------------------------------
███╗   ███╗██╗███╗   ██╗██╗███╗   ███╗██╗   ██╗███████╗    ██████╗     ██████╗ 
████╗ ████║██║████╗  ██║██║████╗ ████║██║   ██║██╔════╝    ╚════██╗   ██╔═████╗
██╔████╔██║██║██╔██╗ ██║██║██╔████╔██║██║   ██║███████╗     █████╔╝   ██║██╔██║
██║╚██╔╝██║██║██║╚██╗██║██║██║╚██╔╝██║██║   ██║╚════██║    ██╔═══╝    ████╔╝██║
██║ ╚═╝ ██║██║██║ ╚████║██║██║ ╚═╝ ██║╚██████╔╝███████║    ███████╗██╗╚██████╔╝
╚═╝     ╚═╝╚═╝╚═╝  ╚═══╝╚═╝╚═╝     ╚═╝ ╚═════╝ ╚══════╝    ╚══════╝╚═╝ ╚═════╝ 
-------------------------------------------------------------------------------
Исходный каталог: /home/test-minimus

Сохранение заметок
        +++ Сохранён: 2020-07-06_recursion.md
        +++ Сохранён: 2020-07-06_vacuum.md
        +++ Сохранён: Животные/2020-07-06_elephant.md
        +++ Сохранён: Животные/2020-07-06_mouse.md

Сохранение тегов
        Сохранено тегов: 5 шт. 

Генерация вспомогательных файлов
        Сохранён: /home/test-minimus/README.md
        Сохранён: /home/test-minimus/.minimus_cache.json
-------------------------------------------------------------------------------
Обработка заняла 0.02 сек.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minimus-2.0.1.tar.gz (11.2 kB view hashes)

Uploaded Source

Built Distribution

minimus-2.0.1-py3-none-any.whl (12.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page