@astrojs/markdoc 0.6.0 → 0.7.0

package/README.md

@@ -458,6 +458,40 @@ To achieve a more Markdown-like experience, where HTML elements can be included
 > **Warning**
 > When `allowHTML` is enabled, HTML markup inside Markdoc documents will be rendered as actual HTML elements (including `<script>`), making attack vectors like XSS possible. Ensure that any HTML markup comes from trusted sources.
 
+### `ignoreIndentation`
+
+By default, any content that is indented by four spaces is treated as a code block. Unfortunately, this behavior makes it difficult to use arbitrary levels of indentation to improve the readability of documents with complex structure.
+
+When using nested tags in Markdoc, it can be helpful to indent the content inside of tags so that the level of depth is clear. To support arbitrary indentation, we have to disable the indent-based code blocks and modify several other markdown-it parsing rules that account for indent-based code blocks. These changes can be applied by enabling the ignoreIndentation option.
+
+```diff lang="js" "ignoreIndentation: true"
+  // astro.config.mjs
+  import { defineConfig } from 'astro/config';
+  import markdoc from '@astrojs/markdoc';
+
+  export default defineConfig({
+    // ...
++   integrations: [markdoc({ ignoreIndentation: true })],
+    //                       ^^^^^^^^^^^^^^^^^^^^^^^
+  });
+```
+
+```md
+# Welcome to Markdoc with indented tags 👋
+
+# Note: Can use either spaces or tabs for indentation
+
+{% custom-tag %}
+{% custom-tag %} ### Tags can be indented for better readability
+
+    {% another-custom-tag %}
+      This is easier to follow when there is a lot of nesting
+    {% /another-custom-tag %}
+
+{% /custom-tag %}
+{% /custom-tag %}
+```
+
 ## Examples
 
 - The [Astro Markdoc starter template](https://github.com/withastro/astro/tree/latest/examples/with-markdoc) shows how to use Markdoc files in your Astro project.

package/dist/options.d.ts

@@ -1,3 +1,4 @@
 export interface MarkdocIntegrationOptions {
     allowHTML?: boolean;
+    ignoreIndentation?: boolean;
 }

package/dist/tokenizer.js

@@ -11,6 +11,9 @@ function getMarkdocTokenizer(options) {
       tokenizerOptions.allowIndentation = true;
       tokenizerOptions.html = true;
     }
+    if (options?.ignoreIndentation) {
+      tokenizerOptions.allowIndentation = true;
+    }
     _cachedMarkdocTokenizers[key] = new Markdoc.Tokenizer(tokenizerOptions);
   }
   return _cachedMarkdocTokenizers[key];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
   "description": "Add support for Markdoc in your Astro site",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -68,7 +68,7 @@
     "@astrojs/prism": "3.0.0"
   },
   "peerDependencies": {
-    "astro": "^3.3.0"
+    "astro": "^3.3.4"
   },
   "devDependencies": {
     "@types/chai": "^4.3.5",
@@ -82,7 +82,7 @@
     "rollup": "^3.28.1",
     "vite": "^4.4.9",
     "@astrojs/markdown-remark": "3.3.0",
-    "astro": "3.3.0",
+    "astro": "3.3.4",
     "astro-scripts": "0.0.14"
   },
   "engines": {