agentleFS
aymericzipaymericzip/intlayer-skills/skills/intlayer-markdown/SKILL.md

intlayer-markdown

Skill5 starsChanged 47 days agoApache-2.0View on GitHub

Declares and renders Markdown / rich text content with Intlayer (md(), .content.md files, MDX components, MarkdownProvider, SSR parsing). Use when the user asks to "add markdown content", "render rich text", "customize markdown components", or "render a markdown string".

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    SSR: call parseMarkdown() on the server and pass the serializable AST to the client.

    line 77

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Intlayer Markdown

Declaring Markdown Content

import { file, md, t, type Dictionary } from "intlayer";

const content = {
  key: "app",
  content: {
    // Explicit markdown
    intro: md("## My title \n\nLorem Ipsum"),
    // Per-locale external files
    article: t({
      en: md(file("./article.en.md")),
      fr: md(file("./article.fr.md")),
    }),
  },
} satisfies Dictionary;

export default content;

Other ways to declare it:

  • .content.md files (since v8.10): a Markdown file with key (and optional locale) in its front-matter, e.g. article.en.content.md, article.fr.content.md.
  • Automatic detection: set contentAutoTransformation: true (per dictionary or globally in intlayer.config.ts) and plain strings containing Markdown syntax are transformed.

Rendering via useIntlayer

An md node renders directly as the framework's native output (JSX, VNode, HTML string). MDX is supported: component names used in the Markdown resolve against the components map.

const { intro } = useIntlayer("app");

<div>{intro}</div>; // Rendered markdown
intro.use({ h1: (props) => <h1 className="title" {...props} /> }); // Local override
intro.value; // Raw markdown string
intro.metadata.title; // Parsed front-matter

Priority: .use() > global provider > default renderer.

Global Configuration

Set default components and options once for the whole app:

FrameworkGlobal configuration
React, Next.js, Preact, Solid, SvelteMarkdownProvider from <package>/markdown
Vueapp.use(intlayerMarkdown, options) from vue-intlayer/markdown
AngularcreateIntlayerMarkdownProvider(options) in ApplicationConfig
AstroinstallIntlayerMarkdown(options) in the middleware and a <script>
Lit, VanillainstallIntlayerMarkdown() next to installIntlayer()

Rendering Raw Markdown Strings

For Markdown that does not come from a dictionary, use the helpers from <package>/markdown: <MarkdownRenderer />, useMarkdownRenderer() and renderMarkdown(). They accept raw strings only, not useIntlayer nodes.

Performance

  • Suspense (React): the parser (~55kb) is loaded lazily. Wrap components rendering Markdown in a <Suspense> boundary, otherwise React suspends at the root.
  • SSR: call parseMarkdown() on the server and pass the serializable AST to the client; every rendering helper accepts it, so the browser skips parsing.

Options

Accepted by the global configuration and the helpers: forceBlock, forceInline, tagfilter (default true, strips dangerous HTML), preserveFrontmatter, components, wrapper, renderMarkdown.

References

Concepts

  • Markdown
  • HTML
  • File

Packages

  • React Intlayer MarkdownRenderer

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.