Reactium
  • Quick Start
  • Discuss
  • Approach
    • Architecture
    • DDD Introduction
    • Domain Model
  • Reactium App Foundation
    • Reactium Guides
      • Creating a Simple Single Page Web App (SPA)
      • Creating a Sassy Style Sheet
      • Reactium Core
      • Reactium + Actinium (APIs)
      • Reactium + REST
      • Plugin Module Guide
      • Animating React Routes
      • Reactium in Production
    • Reactium Domain Model
      • Basic Domain Model
      • Runtime Domain Model
      • Buildtime Domain Model
    • Reactium SDK
      • Reactium SDK Reference
    • Updating Reactium
  • Installing Foundations
    • Before You Install
    • Install Reactium
    • Install Actinium
  • Reactium API Foundation (Actinium)
    • Actinium Core
    • Setting up your User
    • Actinium SDK
      • Actinium SDK Reference
    • Actinium Domain Model
    • Extending
    • Updating
    • Live Query
  • Reactium Toolkit
    • Overview
    • Installation
    • Configuration
    • Customization
    • Creating Elements
      • Sidebar Elements
      • Toolbar Elements
      • Documentation Elements
    • Components
      • Sidebar
      • MenuLink
      • Element
      • Code
      • Markdown
      • Icon
    • Toolkit SDK
Powered by GitBook
On this page
  1. Reactium Toolkit
  2. Creating Elements

Documentation Elements

PreviousToolbar ElementsNextComponents

Last updated 2 years ago

The Toolkit plugin adds the component which takes markdown text and converts it into JSX.

When creating an element via the Reactium CLI (also known as ARCLI), you will be prompted to include documentation.

npx reactium toolkit element

...

[ARCLI] > Documentation?: (Y/n)

You can add a documentation component to existing elements as well:

npx reactium toolkit document
[ARCLI] > Document Name: Documentation
[ARCLI] > Document ID: docs
[ARCLI] > Directory: /My Reactium Project/src/app/components/Toolkit/Test/Documentation
[ARCLI] > Sidebar?: Yes
[ARCLI] > Sidebar Group ID (optional): test
[ARCLI] > Sidebar Label: Test Documentation
[ARCLI] > Sidebar URL?: Yes
[ARCLI] > Sidebar Order: 100

[ARCLI] > A new toolkit document will be created using the following configuration:

{
  "name": "Documentation",
  "id": "readme",
  "directory": "/My Reactium Project/src/app/components/Toolkit/Test/Documentation/Documentation",
  "sidebar": true,
  "group": "test",
  "label": "Test Documentation",
  "url": "/toolkit/test/readme",
  "order": 100
}

[ARCLI] > Proceed?: (y/N)

You can then open the generated readme.md file and use markdown text to document an element.

Markdown