Перейти к содержимому

Оформляем первую заметку: база Маркдауна

Для того, чтобы писать и ре­дак­ти­ро­вать посты с Три­ре­мой, вам нужна программа для ­ра­боты с Маркдаун-­файлами. Их много, но я уже года четыре поль­зуюсь Обси­ди­аном и вам сове­тую — https://obsidian.md/

Как скачаете Обси­диан, откройте через него папку trireme-blog/content/blog (опция Open folder as a vault) — тогда подтя­нутся все нужные настройки и па­рочка полезных плаги­нов: пере­име­новка скрин­шотов и со­здание заметок по шаб­лону.

Офф­то­п: Вы в любой момент можете вычи­стить внут­рен­ности храни­лища и за­пол­нить его своими замет­ка­ми — ­главное не пе­ре­име­но­вы­вайте папку /media/ и не удаляйте blog.11tydata.js.

А пока попро­буйте создать заметку через Ctrl+N.

Заполняем свойства заметки

Если свойств у за­метки нет — беда. Сходите в на­стройки, вклю­чите поль­зо­ва­тель­ские плагины.

В начале каждой новой заметки есть форма с её свой­ствами. Вам не о­бя­за­тельно запол­нять весь этот форму­ляр: главное запол­нить поле title и пе­ре­име­но­вать файл заметки: имя файла станет частью ссылки на заметку.

И да, starred это реальное слово и я не со­би­раюсь менять его на favourite.

Пустой description авто­ма­ти­чески запол­нится содер­жимым первого абзаца, дата авто­матом будет сего­дняш­ней, а поле taglist нужно только тем, кто поль­зу­ется системой тегов. Галочка напротив draft запре­щает Триреме публи­ко­вать эту заметку на сер­вер, а starred выде­ляет пост среди других сердечком (или другим симво­лом, настра­и­ва­ется через -­-­star-­mark в custom.css).

Так-то помимо этого в свой­ствах можно ещё указать

  • layout: внешний вид заметки,
  • thumbnail: будет ли у её ссылки превью с кар­тинкой и с какой,
  • permalink: и notPost: а всё вам расскажи.

Вам пока рано этим заби­вать голову, вы ещё не зна­ете, как ­вы­де­лять болдом и ссы­латься на другие посты.

Форматируем текст

Маркдаун-­разметка может многое, но начнём с базы: форма­ти­ро­вания текста.

В Обси­диане рабо­тают все привычные хоткеи: Ctrl+B, Ctrl+I, Ctrl+K (для ссылок) etc. — если чего забу­дете, просто вызо­вите меню правой кнопкой мыши или пере­на­стройте хоткей в на­строй­ках.

Скриншот контекстного меню в приложении Обсидиан
В выпадайках Paragraph и Insert тоже много интересного

Или можете восполь­зо­ваться шпар­галкой и рас­став­лять форма­ти­ро­вание прямо в про­цессе напи­са­ния.

Если вам нужен спец­символ марк­дауна в тек­сте, поставьте перед ним обратный слеш \ или заключив в блок кода.

Формати-­
рование
Синтак­сис
­Марк­дауна
Кур­сив *text*
Код `code`
Пе­ре­чёрк ~~text~~
Мар­кер ==text==
Жир­ный **text**
Спой­лер !!text!!
LATEX $latex$
 Иконка ::icon::

Spoiler alert: спой­леры и иконки прикру­чены мной и в Обси­диане не отображаются.

Для того, чтобы заработали иконки (например, соцсеточные), положите иконочный исходник в trireme-blog/content/assets/ и пропишите в custom.css путь к нему по шаблону

.iconname {
	mask: url(/assets/iconfilename.svg);
}

Вставляем заголовки, ссылки, изображения

Я советую вам отби­вать каждый блок контента из с­писка ниже пустой стро­кой, чтобы не по­лу­чить некра­сивой ХТМЛ-­структуры и по­тен­ци­альных стран­но­стей форма­ти­ро­ва­ния.

За­го­лов­ки
Заго­ловок первого уровня подтя­ги­ва­ется из поля title заметки
Заго­ловок второго уровня можно набрать так: ## Heading
Заго­ловок третьего уровня это ### Heading
Заго­ловки четвёр­того, пятого и ше­стого уровней вам не нужны.


Ссыл­ки
Ссылка на другую заметку выглядит так: [Другая заметка](end-mark.md), расширение файла опционально. Если наберёте в Обсидиане [[, выскочит поиск по всем файлам с автодополнением.

Внешняя ссылка ничем концептуально не отличается [Внешняя ссылка](https://www.youtube.com/watch?v=dQw4w9WgXcQ). Вообще вам этот синтаксис не нужен: просто выделите текст, нажмите Ctrl+K и сразу же вставьте ссылку. Только не удаляйте https:// в начале.

Ссылка на файл или на исходник картинки — тот же синтаксис: [Ссылка на файл](/media/A-Note-on-the-Type.pdf). Убедитесь, что файл лежит в папке /media/, там же, где изображения.


Изоб­ра­же­ния
Поскольку Markdown-­файлы это чистый текст, картинки в нем не хра­нятся. Вместо изоб­ра­же­ний­ — с­сылки с пре­фиксом для ­пред­про­смотра: ![](markdown-formatting-1.png)

Вы можете обве­сить ссылку альт-­текстом для сле­пых, указать ширину в пик­селях и дать картинке подпись: ! [Скриншот контекст­ного меню в при­ло­жении Обсидиан|300](/media/markdown-formatting-1.png) В вы­па­дайках Para­graph и Insert тоже много интересного.

Прошу, только не пе­ре­име­но­вы­вайте папки /blog/ и /blog/media/ — чтобы вам по всем стан­дартам Марк­дауна не п­ри­ш­лось пропи­сы­вать полный путь до кар­тинки в фор­мате /blog/media/img.png, Трирема подстав­ляет /blog/media/ за вас.


Таб­ли­цы
Под капотом это блок текста с псев­до­гра­фи­кой, который даже не по­ни­мает, как что столбец с циф­рами нужно вырав­ни­вать по пра­вому краю. Вам придётся пропи­сать вырав­ни­вание ручками: либо через правую кнопку мыши › Column › Align..., либо перейдя в Source mode (иконка каран­да­шика в правом нижнем углу) проста­вить двое­точие справа от де­фиса. Как-то так:

Кстати, сырые MD-­таблицы очень недурно выглядят внутри блока кода в Те­ле­граме.

| Вариант   | Зооп| FYI | PycP|
|-----------|----:|----:|----:|
| эльзевир  |  34 |  37 |   4 |
| эльзивер  |  10 |  20 |   2 |
| эльзивир  | +15 |  10 |   2 |
| элзевир   |  +5 |   2 |   0 |
| эльзевьер |   3 |   0 |   1 |

Ци­та­ты

Цитата отби­ва­ется > в на­чале абзаца. Я использую её как ак­цент для ко­ротких фраз, но вы можете настроить на свой вкус.


Блоки кода

	``` language
	code
	```

Те, кому нужна подсветка синтак­сиса в блоках кода, про Марк­даун всё уже знают и не дочи­тают до сюда. Мне лично этот пестряк не сдался, но если что, он заком­мен­ти­рован внутри /_includes/post.njk

# Трирема распознает и выполняет nunjucks-инструкции внутри Маркдауна, поэтому я не могу привести строки целиком. Просто раскомментируйте эти css-файлы
.../prism-okaidia.css" ...
.../prism-diff.css"...

Раз­де­ли­те­ли
Просто ---, но не забудьте отбить пустой строкой сверху, иначе пара­граф выше станет заго­лов­ком.


Этого разно­об­разия должно хватить для 99% заме­ток — сходите в custom.css и на­стройте всё под ­свой вкус. Но это так, поиг­раться, насто­ящая касто­ми­зация будет в следу­ющей серии.