Markdown, not MDX

Write .md files. Hugo does not compile MDX or React components. For reusable presentation use the shortcodes supplied by the shared theme. Unknown shortcodes cause Hugo to fail: check the theme’s layouts/shortcodes/ before using one.

Start a product language folder with _index.md:

  ---
title: "Online Meeting Link"
description: "User documentation for Online Meeting Link."
weight: 10
---

Choose a topic below to get started.

An article uses the same front matter. Set title, a short description, and weight for ordering. The site cascades the theme’s docs content type, so imported pages receive the documentation layout without a /docs/ URL prefix. Do not override url, aliases, slug, or type unless you have checked the generated URLs and layout for both languages.

Keep images in page bundles, next to the Markdown:

  en/
  _index.md
  installation/
    index.md
    settings.png

Reference that image with ![Meeting settings](settings.png). Use Hugo references for page links so invalid references fail the build:

  [Installation]({{< relref "/onlinemeeting/installation" >}})

Avoid hardcoded production hostnames for internal links. Raw HTML is disabled in Markdown by default. For an exception, prefer a reviewed theme shortcode rather than enabling arbitrary HTML globally.

Translations

Use matching relative paths in en/ and de/ to connect translations:

  src/docs/
  en/
    _index.md
    installation.md
  de/
    _index.md
    installation.md

Only real translations are published. An untranslated page does not receive a copied counterpart. The theme’s language switcher may take readers to the other language’s homepage when the current page has no translation.

Each language containing Markdown needs its own _index.md. A language folder may be absent entirely. Images and other resources remain with their language content. Symlinks are not supported in imported documentation.

Public content

The website is public even when the source repository is private. Never put credentials, customer information, or internal-only instructions in published documentation or its assets.