Imported from JiHa-Kim/jiha-kim.github.io (
AGENTS.md). Install upstream withnpx skills add JiHa-Kim/jiha-kim.github.io. Copyright stays with the author.
LLM Instructions for j-kim.link
This file contains instructions for AI agents when creating or modifying content for this blog.
General Guidelines
- I am using the Chirpy theme in Jekyll with a custom pre-processor plugin (
_plugins/obsidian_preprocess.rb). - Automation: The pre-processor runs automatically during the Jekyll build process. You should commit files in the Obsidian-style math and callout format (see below); Jekyll will handle the conversion to the processed HTML format required by the theme.
- Keep these agent-facing instructions in
AGENTS.md. Do not duplicate them in post front matter asllm-instructions. - Maintain a consistent tone and style across posts.
Metadata
- Up to 2 levels of categories (e.g.,
- Machine Learning,- Mathematical Optimization). - Use Title Case for tags and categories.
Math Syntax (Preferred)
Use Obsidian-style math. The pre-processor handles conversion and protects it from Kramdown.
- Inline:
$E = mc^2$ - Block:
$$ \frac{d}{dx} e^x = e^x $$ - Automated Replacements: Use
*for multiplication,|for absolute value, and...for ellipses; the pre-processor converts them to\ast,\vert, and\dots. - Avoid literal
|for pipes; use\vertor\Vertif you want to be explicit, but the pre-processor handles simple ones.
Callouts (Preferred)
Use Obsidian-style callouts. They are automatically converted to styled boxes or collapsible details.
- Standard:
> [!info] Title > Body content with **Markdown** and $math$. - Collapsible (default closed):
> [!example]- Title > Body content. - Collapsible (default open):
> [!question]+ Title > Body content.
Available Box Types (for [!type])
- Math/Logic: definition, lemma, proposition, theorem, example, corollary, remark, proof, principle, axiom, postulate, conjecture, claim, notation, algorithm, problem, exercise, solution, assumption, convention, fact.
- Standard: info, note, abstract, summary, tldr, todo, tip, hint, important, success, check, done, question, help, faq, warning, caution, attention, danger, error, bug, failure, fail, missing, quote, cite.
Markdown Automation
- Prefer unnumbered source headings. Use
numbered_headings: truein front matter when rendered section/subsection numbers are desired.- Write
## Motivation, not## 1. Motivation. - Add
{: .unnumbered}to a heading to skip generated numbering for that heading. - Reference generated heading ids as
@sec:heading-slug; the build renders a numbered section link.
- Write
- Use
numbered_callouts: trueto number math/logic callouts such as definitions, lemmas, propositions, theorems, examples, claims, notation, algorithms, problems, exercises, assumptions, conventions, and facts.- Write
> [!definition] Predictive-State Discrepancy; the build can render the numbered label. - Add a label as
> [!definition] Predictive-State Discrepancy {#def:predictive-state}and reference it as@def:predictive-state.
- Write
- Use
numbered_equations: truefor lightweight equation labels and references.- Put
{#eq:name}at the beginning or end of a display-math block; labels may use letters, numbers, underscores, colons, and hyphens. - Reference it in prose as
@eq:name; the build renders an equation link.
- Put
- Use
ruby tools/new_draft.rb "Draft Title"to scaffold drafts with the automation flags enabled. - Use
ruby tools/lint_markdown_automation.rb path/to/file.mdto catch manual numbering, unresolved equation refs, bare[/]math delimiters, and manual HTML callout issues.
Manual HTML (Only if needed)
If you must use HTML (e.g., complex nesting not supported by Obsidian callouts), always include markdown="1" in the opening tag.
- Example:
<blockquote class="box-definition" markdown="1">...</blockquote>
Interactive Widgets
- Use the existing Interactive Widget Framework (
iaw_skeleton.html,iaw__figure-card,iaw__canvas-shell,iaw__metric-pill, sliders, status items) unless there is a concrete reason not to. - Keep widget visuals clean and consistent with prior posts: neutral surfaces, borders, compact cards, semantic colors, and readable labels.
- Do not add decorative glow effects, arbitrary radial gradients, neon styling, or one-off visual treatments that are not part of the established widget language.
- Prefer data visualization clarity over ornament: encode meaning with position, line style, opacity, and the shared semantic color tokens.
- Add reusable layout, legend, metric, canvas, and footer patterns to
_sass/widgets.scssinstead of redefining them inside individual widget includes. - Scope unavoidable widget-specific CSS to the widget id and keep it minimal; only add styles that the shared IAW classes do not already provide.
Sources and References
Please do not modify sources, references, or further reading without an explicit request.