PIM Fundamentals

Test Markdown Article Format

A proof of concept for the new markdown-based article format with inline JSON elements

Published January 15, 2025
5 min read
Sivert Kjøller Bertelsen
PIM
Testing
Markdown

Introduction to the New Format

This is a test article written in Markdown instead of JSON. The goal is to make content authoring much simpler and more natural.

With this approach, you can write content using standard markdown formatting:

  • Bold and italic text
  • Lists (ordered and unordered)
  • Links like this one
  • Inline code snippets
  • And much more!

Why Markdown?

Markdown offers several advantages over pure JSON:

  1. Natural writing flow - no need to escape quotes or worry about JSON syntax
  2. Better version control - diffs are actually readable
  3. Editor support - syntax highlighting, spell check, preview all work out of the box
  4. Faster authoring - focus on content, not structure
"Moving to markdown reduced our content authoring time by 70% and made it accessible to non-technical team members"
SB
Jane Smith

Advanced Elements Still Available

While most content is plain markdown, we can still embed complex elements using JSON code blocks. This gives us the best of both worlds.

Example: Code Blocks

Here's a regular markdown code block:

const pim = new PIMClient({
  apiKey: 'your-api-key'
});

const products = await pim.getProducts();

And here's a more advanced code element with additional metadata:

javascript
const pim = new PIMClient();
await pim.enrichProduct(productId, {
  description: 'Enhanced product data'
});

Comparison with JSON Format

The old way required writing everything in JSON with escaped quotes and careful syntax. It looked like this:

{
  "content": {
    "en": "This is a **test** with [links](https://example.com)"
  }
}

The new way is just natural markdown:

This is a test with links

Much better!

Comparison table data is incomplete. Please check the content configuration.

Conclusion

This prototype demonstrates that we can maintain our structured content system while dramatically improving the authoring experience.

The parser transforms these markdown files into the existing JSON schema at build time, so no changes are needed to the rendering components.

Next Steps

  1. Test the parser thoroughly
  2. Convert a few real articles
  3. Gather feedback on the format
  4. Iterate and improve

Ready to make content authoring great again!

About This Article

Category: PIM Fundamentals

Review Status: Published

Related PIM Systems: inriver, akeneo

Sivert Kjøller Bertelsen

Ready to Transform Your Product Data Management?

Let's discuss how Impact Commerce can help you achieve your digital commerce goals.