content-security.json.example

{
  "comment_site_url": "Optional absolute site URL used for canonical metadata, sitemap.xml and llms.txt links (example: https://docs.example.com).",
  "siteUrl": "https://example.com",
  "comment_default_description": "Optional fallback meta description used when a markdown page does not define frontmatter description.",
  "defaultDescription": "Technical docs and project pages built with Markdown Amplified.",
  "comment_theme": "Optional site theme: 'default' (or omit) or 'valley' (the AI Valley analytics look). It applies to every page in light and dark mode; visitors keep their light/dark toggle. An unknown name falls back to the default and logs a warning. See README > Themes.",
  "theme": "default",
  "comment": "Optional site name shown in the header. Defaults to 'Markdown Amplified' if omitted. Used as alt text when a banner image is set.",
  "name": "My Site",
  "comment_banner": "Optional banner image shown in the header instead of the name text. Path is relative to the content root (served via /asset/). Falls back to name text if the image fails to load.",
  "banner": "banner.png",
  "comment_banner_themes": "Optional light/dark-mode-specific banners. Each overrides 'banner' for its mode. 'banner' remains the fallback for whichever variant is not set.",
  "bannerLight": "banner-light.png",
  "bannerDark": "banner-dark.png",
  "comment_site_button": "Optional custom button in the header with an icon and optional link. Icon paths are relative to the content root (served via /asset/). Use iconLight/iconDark for light/dark-mode-specific variants. placement: 'left' (before home button) or 'right' (after the light/dark toggle). alignment: 'left' (adjacent to existing buttons), 'center' (same), or 'right' (at the screen edge). url is optional; omit for a non-clickable logo.",
  "siteButton": {
    "icon": "company-logo.svg",
    "iconLight": "company-logo-light.svg",
    "iconDark": "company-logo-dark.svg",
    "url": "https://www.example.com",
    "placement": "right",
    "alignment": "right",
    "alt": "My Company"
  },
  "comment1": "Global home button default. The home button is enabled by default and links to the site root (/). Set 'home' here to change the default for all pages: 'site' (links to /), 'folder' (links to the top-level folder of the current file), any URL string (custom link), or false (disabled).",
  "home": "site",
  "comment2": "Global TOC default. The TOC opens by default on desktop. Set 'toc' to false to start it closed on all pages.",
  "toc": true,
  "rules": [
    {
      "comment": "Password-protect everything in the 'internal/' directory",
      "match": "internal/",
      "password": "changeme"
    },
    {
      "comment": "A single file available only during a specific date window",
      "match": "announcements/product-launch.md",
      "validFrom": "2025-09-01",
      "validUntil": "2025-09-30"
    },
    {
      "comment": "A file that becomes available on a future date and stays available",
      "match": "announcements/hiring-freeze.md",
      "validFrom": "2025-10-15"
    },
    {
      "comment": "A file that was available until a past date and is now gone",
      "match": "announcements/old-offer.md",
      "validUntil": "2025-06-01"
    },
    {
      "comment": "Password + date range combined: board pack available only during the meeting week",
      "match": "board/q3-pack.md",
      "password": "board2025",
      "validFrom": "2025-09-08",
      "validUntil": "2025-09-12"
    },
    {
      "comment": "Password-protected but source markdown is explicitly downloadable",
      "match": "reports/q3-summary.md",
      "password": "readonly",
      "download": true
    },
    {
      "comment": "Public page but download of the source is disabled",
      "match": "legal/terms.md",
      "download": false
    },
    {
      "comment": "Per-file override: one public file inside an otherwise protected directory (no password, no dates)",
      "match": "internal/welcome.md"
    },
    {
      "comment": "Home button: disable globally by setting the top-level 'home' to false instead of 'site'",
      "comment2": "To disable for an entire folder, add a rule like this:",
      "match": "standalone/",
      "home": false
    },
    {
      "comment": "Home button: disable for a single file (e.g. the homepage itself)",
      "match": "index.md",
      "home": false
    },
    {
      "comment": "Home button: override to link to the top-level folder root instead of site root",
      "match": "docs/",
      "home": "folder"
    },
    {
      "comment": "Home button: override with a custom URL for a specific file",
      "match": "reports/q3-summary.md",
      "home": "https://example.com/reports/"
    },
    {
      "comment": "TOC: start closed on a landing/index page",
      "match": "index.md",
      "toc": false
    },
    {
      "comment": "TOC: start closed for an entire section",
      "match": "landing/",
      "toc": false
    },
    {
      "comment": "Site name/banner: use a different header title for a whole section",
      "match": "docs/",
      "name": "Documentation"
    },
    {
      "comment": "Site name/banner: show a section-specific banner image (falls back to name if image fails)",
      "match": "products/",
      "name": "Products",
      "banner": "products/header-logo.png",
      "bannerDark": "products/header-logo-dark.png"
    }
  ],
  "comment_ga": "Google Analytics 4. Set ga_measurement_id to enable. A cookie consent banner is shown by default, and nothing is loaded from Google until the visitor accepts; set ga_consent_banner to false only where consent is not required (e.g. an intranet), and Analytics then loads at once. The _ga cookie stays on the exact hostname unless ga_cookie_domain names a parent domain. ga_privacy_url adds a link to your privacy/cookie policy in the banner; ga_privacy_label overrides the default link text 'Privacy Policy'.",
  "ga_measurement_id": "G-12345XXXXX",
  "ga_consent_banner": true,
  "ga_privacy_url": "https://example.com/privacy",
  "ga_privacy_label": "Privacy Policy"
}