Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.3.x (latest)
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this pageOn this page
  • Prerequisites
  • Specify the markdown rendering module in a document
    • Example
Kong Gateway
3.1.x
  • Home
  • Kong Gateway
  • Kong Enterprise
  • Dev Portal
  • Customize
  • Markdown Rendering Module
You are browsing documentation for an outdated version. See the latest documentation here.

Markdown Rendering Module

The Kong Dev Portal supports Github-flavored markdown (GFM) that can be used in lieu of the templates. Instead of having to create an HTML layout and partials for your templates, you can use custom CSS with the improved markdown rendering module. The extended markdown support improves rendering significantly, especially for tables.

Prerequisites

  • Access to Kong Manager
  • The Dev Portal is enabled and running

Specify the markdown rendering module in a document

  1. Create a markdown file for your Dev Portal documentation.
  2. Call the markdown module using the layout parameter.
  3. Specify the .css file you want to use. You can use the default Github .css as shown, or specify your own custom .css.

    • All markdown CSS classes should be prepended by .markdown-body. This is to ensure that markdown styles do not bleed into other areas of the portal.
    • The .css file should be placed in the current theme’s /assets directory.
    • The renderer assumes the .css path will begin from the /assets directory. See the example below.
    • Other classes defined in any other Dev Portal CSS external to the markdown.css may pollute your rendered markdown. If you want to unset particular styles, you can do so using the /assets/style/markdown-fixes.css file.

Example

/content/markdown-example.md

---
layout: system/markdown.html
css: assets/style/markdown.css
---
Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023