Первая часть скромненького лонгрида про ultimate настройку текстового редактора для работы с Markdown и по превращению вас в более лучшего писателя. http://telegra.ph/Pimp-My-Markdown-Part-I-04-20-2

#markdown #ide #vscode #ru

Абсолютно никак не могу понять, зачем создают вот такие https://danmoop.github.io/plume/ проекты. И тысячи их на всяких producthunt, 3.5 базовых фичи для написания текста, одна более-мене уникальная и все. Просто окошко для набора текста. Остановитесь, пожалуйста.

#ide #en

Подоспели видеоматериалы с Мини-Гипербатона про текстовые редакторы, но при беглом осмотре — слабовато, у меня про retext и remark намного полезнее:
https://events.yandex.ru/events/hyperbaton/24-may-2018/

#ide #video #conference

Эм. По неизвестной мне причине куда-то пропал пост со второй частью лонгрида про настройку Atom для тех, кто хочет научиться лучше комбинировать английские слова в предложения, вот он повторно. (хотя поиском по каналу находится, но его не видно. МАГИЯ)

http://telegra.ph/Pimp-My-Markdown-Part-II-04-20

#markdown #ide #ru

Ну и наконец-то многострадальная статья про рисование графиков в документации буквами. Ловите!

http://telegra.ph/Uchimsya-risovat-grafiki-v-dokumentacii-bez-dizajnera-i-talanta-07-12

#ide #diagram #ru

Yet Another Markdown Editor, но на этот раз разработчик хотя бы поясняет зачем нужен еще один вот такой вот. Пусть будет. https://www.zettlr.com/#why

#markdown #ide #tool

Обновился до 4-й версии Markdown-редактор Inkdrop. Честно говоря, я уже совсем перестал обращать внимание на "специализированные" Markdown-редакторы, т.к ничем они друг от друга не отличаются и ужасно ограничены в наборе фукций. Но Inkdrop это исключение, ведь там есть плагины и даже полезные! До VSCode еще как до луны, но потенциал имеется, пробуйте.

#ide #en #markdown

Все мы любим Docs as a Code, но иногда этого становится мало и хочется ВСЁ as a Code, поэтому в сегодняшней подборке Презентации as a Code (с уклоном в Markdown)

Начну со своих любимых тулз:

Marp — нЕкогда Electron (не переставайте читать на этом месте) приложенька, которая кушает маркдаун и делает из них собсно презентацию, но товарищи разработчики видимо протёрли глаза и наконец поняли что Электрон — есть корень зла и свернули сие богомерзкое деяние в пользу богоподобного расширения для VS Code

Deckset — если в вашем распоряжении есть MacOS и необходимость хоть изредка делать презентации то просто жмите на ссылку и дальше не читайте. Лучшая аппка.

reveal.js — фреймворк для HTML-презентаций. Умеет вложенные солайды, Markdown ☜(ﾟヮﾟ☜), экспорт в PDF, отдельные спикер ноуты. Если впадлу что-то там мудрить, то есть онлайн-редактор. Можно закомбинить это дело с Pandoc.

remark.js — чуть более tricky, чем reveal, но дело делает. Есть подсветка кода в слайдах, нормально всё скейлится, конечно же умеет MD, отдельные спикер ноуты и всякое такое.

hackMD — это как Google Docs, но для Markdown. Тут оно за тем, что там есть режим презентаций :}

Не про Markdown, но Slides as a Code вполне себе — eagle.js — фреймворк для слайдов поверх Vue.js. Самая выпендрёжная из всех систем в списке, без лишних слов: посмотрите демки, до конца.

Notable mentions:

md2googleslides — если вы всё никак не слезете с иглы гугло-экосистемы, то вот можете писать в md, но конвертить во всё тот же Google Slides.

It Is Wednesday, My Dudes, хорошего дня :}

#tool #markdown #ide

В вечер пятницы немножечко про организацию рабочего пространства, а в частности тулз для писательства. Лично я -- фанат VS Code и всем его усиленно советую, т.к это ультимативный редактор с тонной плагинов и вообще, как грица one stop shop, к тому же, это один из немногих проектов на Electron, который не умервщляет ваш ноутбук (кто-то еще работает за стационарными пк?). НО! Но держать еще один инстанс Хрома не нравится примерно никому и какой-никакой, а удар по батарее и общей производительности железки всё же ощутим, но это решаемо, и решаемо довольно легко.

Нам понадобится:

1. Обыкновенный браузер (фаерфокс или хром, ведь других еще не придумали)
2. MacOS или Linux, или Windows с включенным WSL 1\2.
3. Ровно один бинарник взятый отсюда https://github.com/cdr/code-server
4. 10-20 минут жизни, в зависимости от скорости чтения

Чё в итоге?

Получаем полностью рабочий VS Code, запущенный во вкладке браузера.

Минусы:

- Каждое дополнение нужно скачать вручную из VS Code Marketplace, там есть кнопка Download, скачивается .vsix файлик, его и кормите в уже запущенную веб-версию вскода.
- Дополнение GitHub Pull Requests просит более новую версию вскода, починится с апдейтом сервера, ждём.

Плюсы:

- Ваш ноут скажет вам спасибо
- Кому не покажи вскод во вкладке - все балдеют

#vscode #ide #ru

День релизов! (с опозданием)

Доношу до вашего сведения, что недавно хорошенько так обновился code-server.
code-server -- самая правильная версия VSCode, ибо под каким бы соусом не мариновали Electron приложения, оно им и останется. Тут всё иначе, вы запускаете локальный (или любой другой!) сервер и заходите на 127.0.0.1:8080 и вуа-ля, у вас больше не запущено два (ато и три, если вдруг вы зачем-то пользуетесь НЕ веб-версией слака или каким-нибудь Дискордом) инстанса хрома.

Для сравнения мемори футпринты:

```VSCode - 6 электрон-процессов ~ 1Gb of RAM usage

325.16 Mb /usr/lib/electron6/electron
316.66 Mb /usr/lib/electron6/electron
213.11 Mb /usr/lib/electron6/electron
152.18 Mb /usr/lib/electron6/electron
85.18 Mb /usr/lib/electron6/electron
17.36 Mb /usr/lib/electron6/electron
-----
1109.65 Mb

code-server - 3 code-server процесса кушают ~375Mb + 1 вкладка Хрома ~100Mb in host

148.06 Mb /usr/bin/code-server
125.86 Mb /usr/bin/code-server
101.29 Mb /usr/bin/code-server
-----
375.21 Mb

```Результат, как грица, на лицо. Замеры проводились на более старой версии, сейчас может дела даже лучше.

Кроме того, зарелизился Vale v2.1.0, в нем тоже пара новинок. Добавлена поддержка многословных исключений и raw скоупы, чтобы можно было линтить необработанную размету, такой себе улучшенный --ignore-syntax.

А объединяет эти две новости то, что весь редакторский состав этого блога последний месяц в поте лица боролся за то, чтобы две эти шикарные вещи (code-server + vale) наконец-то нормально заработали вместе.

Для полноценной работы вам нужно просто поставить самые свежие версии code-server, vale и vscode-vale.

Пользуйтесь, не болейте. ❣️

#ide #vscode #en

Второй пост - комбинированный:

Избавляемся от нарочитых и подсознательных предвзятостей, опять же с помощью наших верных друзей - линтеров и засовываем Grammarly в VS Code

- Linter (вот так просто) на Руби (eww) помогает с inclusive language: gender-coded words, use of pronouns and misused words.
- Я когда-то давно писал о нём, но раз такое дело, то есть еще и linter-alex (alexjs)(в честь гендерно-нейтрального имени Саша), который делает почти то же самое.
- Кто-то захакал Grammarly прямо в VS Code, расширение конечно же сразу снесли с стора с экстеншнами, но еще можно скачать vsix файл, установить его в ручную и поклацать

#testthedocs #vscode #ide #tool #en

Я некогда писал об Obsidian. Это такая "база знаний", но без "облачных" примочек, живёт это дело поверх локальной папочки с .md файликами. Можно смотреть связи и всякое такое.

Недавно на глаза попалось нечто похожее под названием Foam. На этот раз всё обёрнуто в vscode и приправлено довольно популярными расширениями. Автор предупреждает, что пока всё готово примерно на ~10%. Можно залайкать и следить за релизами, авось чего и вырастет из этого

#ide #knowledgemanagement #tool #markdown

Похоже у нас с вами вот-вот появится своя IDE (IWE?) от JetBrains!

#ide #en

Выходим из недельного застоя:

1. Статья о шести характеристиках хорошей докментации. Тут без откровений. Характеристик хорошей документации куда больше, но помнить об основе — надо

🔗Читать: Six characteristics of good docs

2. Если вы любитель «second brain» приложений а-ля Notion, есть большая вероятность, что вы уже открыли для себя Obsidian, про который я когда-то уже пару раз писал. Из подписчиков точно кто-то пользовался в компании. Так вот, для него вышел плашин с лучшим линтером простого, челвоеческого английского — Vale. Есть поддержка как и платной серверной версии, так и бесплатной CLI.

🔗 Читать: New plugin: Obsidian Vale

3. Из личного опыта. Писал тут когда-то про Mark — утилиту для синхронизации .md файлов с Clonfluence, которую можно запрячь в CI и вот это вот всё. Пост вызвал относительно бурную дискуссию и в том числе упрёки, что ничего там не работает. Добрался я таки до этой тулзы сам и имею сказать, что все работает. Пользоваться рекомендую Докер-образом и в качестве пароля передавать API-токен. Работает даже на Маке.

#ide #knowledgemanagement #en #testthedocs

JetBrains запостили у себя статью, которая у меня была отложена на поделиться с вами попозже, так что here we go!

В статье автор усиленно сетует на стагнацию техрайт тулинга, на отсутствие каких-либо стандартов (да, десятки сортов markdown, asciidoc, DITA и прочие, это мы про вас), отсутствие версионности, предназначенной для документации и всякое такое (статья хорошая, советую прочесть, проникнитесь может)

Но больше всего из этого интересен тред самих JetBrains, где они рассуждают, что стандарт упрощенного языка разметки нужен, и он как раз должен быть таким, каким описал его автор статьи.

🤔 К чему пришли в JetBrains в своей новой IDE для Техписов:

>What we’ve come up with for ourselves is a semantic XML-based markup with smart completion along with Markdown support. And you can mix the two in any proportion to stay light and still inject more complex markup if you need extra features like tabs or advanced code blocks.

🔗 Читать: Better docs, less pain: the case for new docs-as-code standards

#ide #en #markdown #article

Вспомнилось тут в свете (надеюсь) скорого релиза IDE от JetBrains для техписателей, что есть кайфовый плагин для IntelliJ IDEA которым можно пользоваться уже сейчас.

Проверяет орфографию, грамматику и стиль, такой себе встроенный граммарли

🔗 Почитать больше о Grazie

#testthedocs #ide #en

👅 Языки:

#ru | #en

👷 Карьера:

#career — советы и всемозможные статьи о карьере техписателя
#conference — техписательские конференции, их записи и заметки
#resources — ресурс для саморазвития
#article — полезная статья, которая учит чему-то клёвому, что позволит стать более лучшим писателем
#vacancy — интересная вакансия или что-то связанное с наймом
#video — видео, видос, видосичек, видосюлька. И подкасты!
#book — книга/хендбук
#courses — курсы, программы для технических писателей

🛠 Технологии:

#tool — полезная утилита/приложение
#changelog — все о чейнджлогах, примеры, правила
#markdown — все о языке разметки Markdown
#reStructuredText — все о языке разметки reStructuredText
#asciidoc — все о языке разметки asciidoc
#LaTeX — все систему набора и вёрстки и язык разметки LaTeX
#ide — среды разработки и все что с ними связано
#vscode — все о Visual Studio Code, настройка, плагины, хитрости
#SSG — JAMStack, генераторы статических сайтов, Hugo, Jekyll, Antora, etc.
#testthedocs — тестирование документации, линтинг
#API — про документирование API, примеры, лайфхаки, подсказки
#diagram — про диаграммы (много про diagrams as a code), mermaid, UML
#screenshot — все про скриншоты, утилиты, сервисы и красивенькие фотоснимки экрана
#ai — про GPT, GitHub Copilot и прочее, где ИИ помогает нам писать

🧺 Общее:

#tonevoice — о правилах общения в документации
#language — что-то конкретно о языке, в основном английский
#legal — юридическая документация, лицензии
#styleguide — все о стилях и правилах
#DocsAsCode — все про подход к документации как к коду
#example — примеры документации (хорошие и плохие)
#uiux — интерфейсы, текст в интерфейсах, пользовательский опыт
#knowledgemanagement — менеджмент знаний, хранилища, тулзы, техники, советы и наблюдения
#versioning — про версионирование
#accessibility — все об аксессебилити в документации
#checklist — чеклист/шпаргалка
#vintage — винтажная документация, старые компьютеры, софт, техника, игры
#visual — про визуальную составляющую документации
#metrics — все о метриках документации
#random — что-то совсем косвенно относящееся к техписательству, юморески

Предлагайте новые хэштеги в комментариях!