Skip to main content

Documentation Features

This page demonstrates all the features available in Camouflage documentation.

Table of Contents​

The right sidebar shows a table of contents with all headings on the current page. It automatically highlights the section you're reading and provides quick navigation.

Admonitions (Callout Boxes)​

You can use various types of callout boxes to highlight important information:

note

This is a note admonition. Use it for general information and helpful tips.

tip

This is a tip admonition using our Lightning Green brand color. Use it for best practices and recommendations.

info

This is an info admonition. Use it for additional context or background information.

caution

This is a caution admonition. Use it for warnings about potential issues or things to be careful about.

danger

This is a danger admonition. Use it for critical warnings about destructive actions or security risks.

Code Blocks​

Code blocks support syntax highlighting and have a copy button:

# Deploy Camouflage Relay Server
docker run -d \
  --name camouflage-relay \
  -p 4433:4433/udp \
  -e RELAY_HOST=relay.example.com \
  camouflage/relay-server:latest
# Docker Compose configuration
version: '3.8'
services:
  relay:
    image: camouflage/relay-server:latest
    ports:
      - "4433:4433/udp"
    environment:
      - RELAY_HOST=relay.example.com
// Client connection example
const client = new CamouflageClient({
  relayServer: 'relay.example.com:4433',
  networkId: 'your-network-id',
  authToken: process.env.CAMOUFLAGE_TOKEN
});

await client.connect();

Inline Code​

You can use inline code with our Lightning Green accent: camouflage-cli, docker-compose, kubectl.

Tables​

FeatureCommunity EditionEnterprise Edition
Relay Servers1Unlimited
Gateway NodesUnlimitedUnlimited
Client Devices25Unlimited
ACL RulesBasicAdvanced
SupportCommunityPriority

Blockquotes​

Camouflage Networks provides secure, private network infrastructure built on modern QUIC technology. It enables seamless connectivity across distributed environments while maintaining enterprise-grade security.

Edit This Page​

At the bottom of each page, you'll find an "Edit this page" link that takes you directly to the GitHub repository where you can propose changes to the documentation.

Previous/Next Navigation​

Navigation cards at the bottom of each page help you move through the documentation in a logical sequence.

Last Updated​

Pages show when they were last updated and by whom (when available from Git history).

The breadcrumb trail at the top shows your current location and allows quick navigation back to parent pages.

Mermaid Diagrams​

See the Diagram Examples page for comprehensive diagram examples using Mermaid.

The search bar in the navigation allows you to quickly find any content across the entire documentation.

Dark Mode​

Click the theme toggle in the navigation bar to switch between light and dark modes. The documentation automatically respects your system preferences.

  • Collapsible categories: Click category headers to expand/collapse sections
  • Active highlighting: The current page is highlighted in Lightning Green
  • Nested navigation: Multi-level hierarchy for organized content
  • Hideable sidebar: Click the button to hide the sidebar for more reading space

Typography​

The documentation uses the Inter font family for excellent readability:

  • Headings use different weights (600-700) for clear hierarchy
  • Body text uses 400 weight for comfortable reading
  • Code uses SF Mono for technical content
  • All text is optimized for both light and dark modes