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
  • Usage
  • Properties
  1. Reactium Toolkit
  2. Components

Markdown

Component used to present documentation in a Toolkit element

Usage

The Markdown component takes markdown text and converts it into JSX. Simply import a .md file into your element and pass it to the Markdown component as the value property:

MyElement.js
import React from 'react';
import readme from './readme.md';
import { useHookComponent } from 'reactium-core/sdk';

const MyElement = () => {

    const { Markdown } = useHookComponent('RTK');
    
    return <Markdown value={readme} />
};
readme.md
# Title
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

Some **bold**, *italic*, ~~strike~~, and `code` text

```
<div>markup</div>
```

> Block quote

The Toolkit plugin extends the Reactium Webpack configuration to allow .md file imports.

Properties

Property

Type

Description

Value

String

The markdown text

PreviousCodeNextIcon

Last updated 4 years ago