Skip to main content

General

Component Showcase

A live demonstration of the new rich content components available in the Proxus documentation system.

This page demonstrates the custom Markdoc components we've added to the Proxus website. You can use these in both Docs and Blog posts.

1. Badges New

Use badges to highlight status, version requirements, or alerts inline.

  • Default: v1.0
  • Tip: Recommended
  • Note: Beta
  • Warning: Deprecated
  • Danger: Breaking Change

2. Card Grids & Link Cards

Perfect for landing pages or section overviews.

hub

Unified Namespace

Learn how to architect your IIoT data using the ISA-95 standard and MQTT.

router

Edge Computing

Deploy logic close to the source with our distributed architecture.

menu_book

Documentation

Read the technical guides and API references.

rss_feed

Blog

Latest news and technical deep dives.

3. Step-by-Step Guides

Use the {% steps %} wrapper to create vertical timelines. Great for installation or tutorial guides.

Install the CLI

First, install the Proxus CLI tool globally on your machine.

npm install -g proxus-cli

Initialize Project

Create a new project directory and initialize it.

mkdir my-factory
cd my-factory
proxus init

Deploy to Edge

Push your configuration to the connected gateway.

lightbulb
Pro Tip

Make sure your Gateway is online before deploying.

4. File Trees

Visualize project structures or configuration hierarchies.

  • draft proxus-config.toml
  • draft docker-compose.yml
  • folder scripts
    • folder ProductionLine
      • draft OEE_Calculation.cs Calculates Overall Equipment Effectiveness
      • draft EnergyMonitor.cs Monitors energy consumption
  • draft README.md

5. Standard Callouts (Existing)

Just to ensure they still work alongside new components.

info
Note

This is a standard note callout.

warning
Warning

Be careful with this configuration in production.

Next →
Supported Protocols