{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["configOptionRequirements","partial"]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"Use AsciiDoc content","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"use-asciidoc-content","__idx":0},"children":["Use AsciiDoc content"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Realm","Revel","Reef"],"plans":["Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the AsciiDoc plugin to render ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".adoc"]}," files as regular content pages in Realm."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Experimental"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is an experimental feature."," ","Its behavior may change in future releases."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"about-the-plugin","__idx":1},"children":["About the plugin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The AsciiDoc plugin package is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@redocly/realm-plugin-asciidoc"]},"."," ","When enabled, it scans content files with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".adoc"]}," extension, creates pages, and includes content in:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["page search index"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["AI search documents"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llm.txt"]}," generation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"install-the-plugin","__idx":2},"children":["Install the plugin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Install the package in your Realm project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"pnpm add @redocly/realm-plugin-asciidoc\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"enable-in-redoclyyaml","__idx":3},"children":["Enable in redocly.yaml"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the plugin to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plugins"]}," list in your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"plugins:\n  - '@redocly/realm-plugin-asciidoc/plugin.js'\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-adoc-files","__idx":4},"children":["Add .adoc files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create AsciiDoc files in your content directory, for example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"adoc","data-title":"content/getting-started.adoc","header":{"title":"content/getting-started.adoc","controls":{"copy":{}}},"source":"= Getting started with AsciiDoc\n:description: A short AsciiDoc example page.\n:keywords: asciidoc, docs\n\nAsciiDoc pages are rendered in Realm with search support.\n\n== Features\n\n- Lists\n- Tables\n- Code blocks\n- Admonitions\n\n[source,typescript]\n----\nconsole.log('Hello from AsciiDoc');\n----\n\n== Links\n\n- xref:./another-page.adoc[Cross-file link]\n- link:https://redocly.com/docs/realm[External link]\n","lang":"adoc"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"diagrams","__idx":5},"children":["Diagrams"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The AsciiDoc plugin supports rendering Mermaid, PlantUML, and Excalidraw diagrams."," ","Use an open block whose style matches the diagram type:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"adoc","header":{"controls":{"copy":{}}},"source":"[mermaid]\n--\ngraph LR;\n  Design --> Preview --> Publish\n--\n","lang":"adoc"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"adoc","header":{"controls":{"copy":{}}},"source":"[plantuml, format=\"svg\", id=\"request-flow\"]\n--\n@startuml\nClient -> Server: Request\nServer --> Client: Response\n@enduml\n--\n","lang":"adoc"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"adoc","header":{"controls":{"copy":{}}},"source":"[excalidraw]\n--\n{ \"elements\": [ { \"type\": \"rectangle\", \"x\": 10, \"y\": 10, \"width\": 200, \"height\": 100 } ] }\n--\n","lang":"adoc"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm always renders diagrams as SVG."," ","If you include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," attribute for compatibility with Asciidoctor diagram syntax, it is ignored."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/add-diagram"},"children":["Add diagrams"]}," for more details on each diagram type."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"limitations","__idx":6},"children":["Limitations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because this feature is experimental, expect gaps with advanced AsciiDoc syntax and extensions."," ","If an unsupported pattern appears, simplify the markup or use Markdown/Markdoc for that section."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":7},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content"},"children":["Content types"]}]}," - Explore the different types of content you can use in your project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/add-diagram"},"children":["Add diagrams"]}]}," - Learn how to enhance your project with diagrams"]}]}]},"headings":[{"value":"Use AsciiDoc content","id":"use-asciidoc-content","depth":1},{"value":"About the plugin","id":"about-the-plugin","depth":2},{"value":"Install the plugin","id":"install-the-plugin","depth":2},{"value":"Enable in redocly.yaml","id":"enable-in-redoclyyaml","depth":2},{"value":"Add .adoc files","id":"add-adoc-files","depth":2},{"value":"Diagrams","id":"diagrams","depth":2},{"value":"Limitations","id":"limitations","depth":2},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"products":["Realm","Revel","Reef"],"plans":["Enterprise","Enterprise+"],"keywords":{"includes":["AsciiDoc","plugin","experimental"]},"seo":{"title":"Use AsciiDoc content"}},"lastModified":"2026-06-10T08:51:12.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/content/asciidoc","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}