Skip to content
EkLine Documentation

Framework Support

Configure EkLine for your documentation framework to improve MDX (Markdown + JSX) file analysis.

EkLine can be configured for popular documentation frameworks. When you specify a framework, EkLine adjusts how it processes MDX files to better analyze content inside framework-specific components.

Why framework support matters

Section titled “Why framework support matters”

Documentation frameworks like Mintlify use custom MDX components to create rich layouts. These components often contain important prose that you should check for quality.

The problem: Without framework awareness, EkLine may treat custom components as code blocks and skip the text inside them.

The solution: Set the framework option to tell EkLine how to process your MDX files. EkLine then extracts and checks content from framework-specific components.

Example: Mintlify Note component

Section titled “Example: Mintlify Note component”

Without framework configuration:

<Note>
  Users shoud configure there API keys before proceeding.
</Note>

EkLine might skip this content entirely, missing two spelling and grammar errors.

With framework: "mintlify": EkLine detects that <Note> is a prose component and checks the content, catching:

  • “shoud” → “should”
  • “there” → “their”

Supported frameworks

Section titled “Supported frameworks”

EkLine accepts the following framework values:

FrameworkValue
Mintlifymintlify
Astroastro
Fernfern
Docusaurusdocusaurus
GitBookgitbook

Mintlify

Section titled “Mintlify”

Mintlify is a modern documentation platform with beautiful, customizable components. EkLine has comprehensive support for Mintlify’s component library.

Configuration

Section titled “Configuration”

Create an ekline.config.json file in your project root:

ekline.config.json
{
  "contentDirectory": ["."],
  "framework": "mintlify",
  "excludeDirectories": ["node_modules"]
}

How it works

Section titled “How it works”

When framework: "mintlify" is set, EkLine:

  1. Detects Mintlify components in your MDX files
  2. Identifies which components contain prose, like <Note>, <Card>, and <Update>
  3. Extracts the text content for quality checking
  4. Skips code-focused components (like <CodeGroup>, <Snippet>)

Prose components

Section titled “Prose components”

EkLine checks content inside these Mintlify components:

  • <Note>, <Tip>, <Warning>, <Info>—Callout boxes
  • <Card>—Card components with content
  • <Accordion>, <AccordionGroup>—Expandable sections
  • <Update> — Changelog entries
  • <Step>, <Steps> — Step-by-step instructions
  • <Expandable> — Expandable content
  • <Tab>, <Tabs>—Tabbed content

Skipped code components

Section titled “Skipped code components”

These components are intentionally skipped because they contain code, not prose:

  • <CodeGroup> — Code examples
  • <Snippet> — Reusable code snippets
  • <Frame> — Image and video frames

Example configuration

Section titled “Example configuration”

For a typical Mintlify project, your ekline.config.json might look like:

ekline.config.json
{
  "contentDirectory": ["."],
  "framework": "mintlify",
  "styleGuide": "google",
  "excludeDirectories": ["node_modules", "api-reference"],
  "excludeFiles": ["mint.json"]
}

Other frameworks

Section titled “Other frameworks”

For Astro, Fern, Docusaurus, and GitBook, create an ekline.config.json file and set the framework option to enable framework-aware processing:

ekline.config.json
{
  "contentDirectory": ["src/content/docs"],
  "framework": "astro",
  "excludeDirectories": ["node_modules", "dist"]
}

Troubleshooting

Section titled “Troubleshooting”

Content inside components not being checked

Section titled “Content inside components not being checked”

  1. Verify framework is set correctly in your ekline.config.json file:

    ekline.config.json
    {
      "framework": "mintlify"
    }

  2. Check for typos:

    // Correct
    { "framework": "mintlify" }
    

    // Wrong - case sensitive
    { "framework": "Mintlify" }

  3. Ensure the component supports this: Not all components contain prose. Code blocks, images, and similar components are intentionally skipped.

Framework not recognized

Section titled “Framework not recognized”

If you see a warning about an unrecognized framework value, check that you’re using one of the supported values: mintlify, astro, fern, docusaurus, or gitbook.

Request a framework

Section titled “Request a framework”

Need support for a different framework or specific components? Contact us with details about your documentation setup.

Next steps

Section titled “Next steps”