d9k-obsidian-style-guide

Предназначено для работы в Obsidian с установленным расширением Icon Shortcodes.

• See 🔰 Basic formatting syntax | Obsidian Help
• See 📺 Every USEFUL Markdown Syntax That I Use in Obsidian | FromSergio | YT
• See recommended plugins | d9k-textbook

Folders structure

• /.cfg/obsidian/: Obsidian config
  • /.cfg/obsidian/snippets/ - CSS snippets for Appearence -> CSS snippets in settings.
  • .cfg/obsidian/plugins/obsidian-apply-patterns/data.json - patterns for Apply patterns plugin
• /markdown-autocomplete/: autocompletions for Various complements plugin.
• /obsidian-templater/: templates for Templater plugin.

Installation

ln -s obsidian-style-guide/.obsidian.vimrc .obsidian.vimrc
ln -s obsidian-style-guide/.cfg/obsidian .obsidian

...

Настройки расширения Icon Shortcodes:

Replace emoji shortcode with emoji character: disabled
Icons Packs: Lucide, Obsidian's built-in icons

Checkboxes (subtasks)

• custom-checkboxes.css CSS snippet required

• to do

• done

• [-] decided not to do

• [/] partially done, need polish/fine tuning/small fixes

• [?] hold, need decision

• [>] deferred

• [!] urgent

Legend in emoji

Helps to focus attention faster and navigate easier .

Partially implemented in my Obsidian templates (doc).

Services helping to find emojis for legend

• EmojiCombos.com

Big task status

• 🔲 open
• ⏳ in development
• ❎ partially done, no further planning yet
• ✅ done
• ✋ on hold/on pause, неприоритетно сейчас
• 🔥 urgent
• 🚫 cancelled / susupended / fail to do
• 🔱 partial: task is big, with different status another file

Code execution location

• 🖥️ frontend
• 🧊 BFF
• :luc_hard_drive: backend service
• :luc_database: database

Requests

• :luc_move_vertical: requests exchange
• ⬇️ GET
• ⬆️ POST/PUT

Comparison

• :scales: comparison of many options
• #vs comparison of 2 options
• 📜 list
• ✨ plus, feature
• 🦠 minus, flaw
• ❓ answer needed

Links

• :luc_git_pull_request: GitLab / repo
• 🎨 Figma / graphical design layout
• 🐞 tracker: bug
• ✨ tracker: new/improvement

Subject/category

• 💪 self-development
• 🥋 proficient knowledge
• 🏄 just exploring possibilities (лёгкая увлекательная активность)
• :shopping_trolley: to buy

Content/information

• 🏇 YouTube Shorts
• 📺 video
• 🎧 podcast
• 📰 article
• ℹ️ information block / explanation
• 👆 source
• 💥 news article (as explosion - short, draws attention but have temporary value)

IT

• :sleuth_or_spy: analyze/investigate unusual behavior reasons/in-code search
• 🌵 branch / fork
• 🧑‍🚀 research/experiment
• 🏃 run tutorial
• 📐 architecture
• :robot_face: automation
• 👤 access
• ↔️ diff
• 🔌 environment, connection, credentials
• 🚨 error code/text, crash
• ⚠️ warning
• 👁️ log
• 🧰 tools
• 📂 path to file locally/on repo
• 🎈 interactive demo
• 🔰 documentation
• 📶 stats
• 🥶 slow
• 🚀 fast / speed
• ⏩ MVP
• 🚪 project homepage ^d9k-homepage-2023-11-08
• 🩺 DevTools, debug
• 🔧 configure, tool
• 🧑‍🔧 fixing other people's code by myself
• 🏗️ build command / tool / boilerplate / starter template
• 🌱 raw functionality (alpha/beta)
• 🧩 plugin / extension / module / specialized small tool
• 🍂 deprecated / abandoned / no updates for long time
• 🌿 [compatible with] fresh version
• 🖧 LAN URL
• 🏹 pull request
• 🪵 crutch / temporary solution
• :ballot_box_with_ballot: parameters
• #️⃣ table
• 🧪 test

• ⚗️ test: big / TDD
• :woman-shrugging: test not reproduced

• 🔃 small refactor
• 🪚 big refactor
• :lower_left_paintbrush: дизайн / CSS / styling
• ⛲ root/parent task link
• ➡️ route
• 👉📘 to documentation / README
• 🏛️ internet archive / non-original / mirror link

Writing articles, structuring notes

• 👉:spiral_note_pad: write to textbook, the provide link
• 📝 write note/summary
• ✍️ write an article/post
• 👉 local link
• 👉🔱 local partial link
• 👈 local link back (from partial to whole)
• 📍 moving link (i. e. current task)

Communication

• 💬 discussions on forums/issues
• :speaking_head_in_silhouette: asked question
• 👥 community
• [-] 😎 contacts / people
• :male-office-worker: author / contact / social network account
• 🚧 (author not responding or doesn't plan to fix)
• 🔔 waiting for answer
• 🔄 last checked ${last_check} / ${since}
• 🙅 no answer for long time ${last_check} / ${since}

Program code navigation

• 🖨️ link to code listing
• 📂 📃 code file path
• 🔣 code snippet
• 🪧 code example (short) by following URL
• 🧱 structure
• 🡤 declaration of fn/class/variable, definition
• 🗿 const / constant string
• 📦 class / type
• 💎 visual component
• 🔗 usage
• ↪️ fn call
• ⛳ search for place in code (usually to edit / related to task context)
• ⚡ CLI command
• ⚙️ internals
• :luc_play: action, event
• 🌳 project

Search

• 🔎 to search ^af618e
• ♾️ (potentially) infinite list (search, filter, infinite scrolling)
• 👀 ссылка на поиск с определёнными фильтрами
• 🏷️ tags, keywords to find this chapter later

Emotional valuation

• ❤️‍🔥 motivation
• :thinking_face: doubt in solution
• 🤯 mind blown, all of a sudden
• 👍 cool
• 🏆 incredibly cool
• ⛏️ hard/tedious work
• 🍂 not related
• 🥱 me lazy / not interested

Planning

• 📤 extract subtask
• 🎯 external requirements / goals

Github repo

• ⭐ stars count
• 🐞 bugs count ( opened / ( closed + opened ) = percentage_of_opened)
• 🪜 commits count (month / year / total)

Other

• 🎓 theory, education
• 🕹️ gaming (entertainment)
• 👟 training
• 💱 currencies exchange
• 💲 very paid (free ver. non-existent/very limited)
• :dove_of_peace: free
• "Citation"
• (Σ) result, conclusion, brief solution
• ♻️ updated at (watching for something)

TODO

• 💰📊
• 📁📂
• 🤺
• ⛲
• 🔭
• 🧵🧶
• 📎
• :large_green_circle: 🏁
• ✳️ ❇️ 🌴
• 🗝 key to problem?
• 🪜
• 🪵
• 🧭
• 🪺
• 🏕️
• 🥋 proficient knowledge?
• 🛸 неожиданное / инопланетные технологии?
• 🚰
• 🔧
• 🛡️
• 📌
• 🌡️
• 🎨 творческое задание?
• 🎬
• 🚜
• 📡 🛜 📶
• 📷
• 💻 🖥 🖧
• 💀💾:fallen_leaf:🏺🗿🪦👴🧀🐗🐚? deprecated
• 🎲🧊📦🥡🎁🪟
• 🎖️🫶
• 🗃️🗄️📚
• 🪣🛢️🏺⚱️🧺
• 🚀📣📢🔊
• 🔩 ⚒️ 📎 📍 📌
• 🤴🏻🧝🏻‍♀️:crown:🏰:male-teacher::man_in_business_suit_levitating::briefcase:
• 🐾 📨 🗺️ 📖 📝
• 🍥 🌀 💈 🧶 🍭 🧬
• 🔐 ❤️‍🔥 🔑
• 👨‍🍳 👨‍🔧 🧑‍🔬 🧑‍💻
• ⛑️ 🪖 🛂
• 🗳️ 🌾 💎 🧺
• ☢️
• ⏏ ➡️ 🏹 🆙 🏓 🔁 🍹
• ✌️ 🚁 🥷
• 🦞
• 🔜 🔖 🚀 💡 🍀 📦 ✈ 🙌 🥁 ⚓🕯️ 🐝
• 🐇🚲🛞📯🦄🏂🏼🥷🏼🥪🆙💾⏩
• 🐙👾🕷️🕸️ 🩻🎛️
• 💿💽
• 🐈🐱😼
• 🐪
• ⛲
• ⛺ 🛖 🏡 🪹
• 🌐🧩
• ⭐
• 🐪 GitHub / Git / Gitlab / Source hosting
• 😵‍💫 😳 🥵 🫨 🥸
• 🏚️ 🍄 🙅 🆑 🈲 🐒 🕷️ 🕸️ 🦨 🎱
• 🐇 ? target DOM element / program object
• :obs_up_curly_arrow_glyph: declaration of fn/class/variable
• :sleuth_or_spy: 👨‍✈️ 🔎:spiral_note_pad: 🧭 ☸️ 🕸️ 🛣️ ? отзывы
• 🌷:seedling:🌸 🌿 fresh
• :obs_quote_glyph: 🖇️ 📎 quote
• 🗃️ 🗂️ 📑 📇 🗓️ 🗄️ 🎬 💽 🪣🛢️🥡 📁 📂 🏕️ 📕 💼 🛄 🧊 💿 📐 🪤 📌 🌳 project
• 🦕
• 🗂️📒🗒️ 🗎 🗄 🕮 ✎🗒 🪄 📃 :luc_pen_tool: 📕📗⎙ 🖋️#️⃣ 📔 📓 🗄️ 📐 ✏️ 🖍️ ✍️ 📝🖊️ ✍🏼 📑 💻 🧷 🖇️ ⌨ ⌨️ 🪢📣 𖥻 📼 🧺 ⚜️ 💡🤝 👣 🕯 🔆 🎇 🫙🏛️🏛 🧑‍🏫 🪶 🔦 👩‍⚖️ 👉📘 👉🔰 🌀 ✍🏽 ˗ doc
• ⬆️⬇️ #WebDev
• 🩹 validate fn
• ⚓ path in UI
• 🍯 🐝 🗃️ 🛢️🏺⚱️🧺 🪵 🧊 materials, assets, resources
• :robot_face: 👾 🪄 🧠 🫧 🧿 ⬛ 🎬 🥷🏽 🪬 🐸 🗿 👽 🩻 🐴 🏇 🐎 🦾 🌀 🔩 🐉🎠 🚠 🚂 🚋 🚗 🏎️ 🚛 🦏 🦔🚇 🚜 🧑‍🍳 🐜 :unicorn_face: AI generated
• 🚂 🚛 🚚 🚀 🚖 🏃 🏃🏻‍♂️‍➡️ 🚜 - automation (alternative)
• 🐌 🐢 ❆ ༄ ⛄ 🥶 🏖️ 🚴 slow?
• 🏍 🚀 ⚡ 🏇 🐎🏃🌶️ ♨️ 🏎️ 🏍️ 🫨 🚄 🚅 🏎 ⏭ ᯓ🏃🏻‍♀️‍➡️❤️‍🔥🌡️🦅 🐇 🥵 🦾 👢 🥾 👣 🪽 ⛵ fast? / speed?
• 🌱🪹🪬:fountain: - root?
• :luc_play: ▶️ ➡️ ^{𝑓 ()} 𝑓𝓃 ƒ𝑛 - function / method?
• ℹ️ 💬 📖 - explanation
• 💡 🧠 💭 ☁️ 👄 🧵 - idea
• 👁️ - log
• 📖 📕 📚 📔 - book?

Foldable blocks

Common case

Example with <details> and <summary>

alert('Hello, world!');

HTML code

Придётся использовать плагин Spoiler Block с кастомным стилем (CSS snippet).

<button type="button" onclick="alert(1)">
	<span>button</span>
</button>

Images embedding

Link to other note

• [[tasks]]
• [[ts-recipes|d9k-textbooks: ts-recipes|]]

Link to same page

Link to header

• [[#Legend in emoji]] - type [[]], then # inside.

Link to block on same page

• [[#^d9k-homepage-2023-11-08|project homepage]] - type [[]], then ^ inside. Rename if you want.

Link to header on another page

• [[linux-search#Replace in files|linux-search > Replace in files]]

Link to block on another page

• [[npm-services#^d9k-cdn-for-deno-2023-11-08|CDN for Deno]]

Embed block from another page

Add ! before local link.

![[js-webassembly#^d9k-WASI-quote-2023-11-08]]

Incuts / callouts

[!example] example See examples below

[!quote] Mark Twain: "Whenever you find that you are on the side of the majority, it is time to reform."

[!info] See Callouts - Obsidian Help for more

Note

Just a quick note with a

[!todo] TODO

Tip

Use can show code in the incut:

{ "this": { "is": ["example", "code"] } }

[!abstract] That's about incuts/callouts

[!success]- The end after the long steps.

[!faq] Frequently Asked Questions

[!warning] Something is wrong?

[!tip]

Can we nest and fold?

Yes. But right now (2026.02) the nested blocks with multiple blocks on the same level are broken

[!danger]- Don't open!

[!failure] here's your failure

[!bug]- ok, fix the bug then

[!success] the bug was fixed

Metadata

• 2023.11 | ♻️ 2024.08
  • created time | update time
• 2023.11
  • create time only

Manual tests

• HTML test
• markdown test
• apply patterns tests