doc-components

React components that help you build documentation sites for other React components.

✓ Designed for use with create-react-app
✓ Helps with importing Markdown files that include syntax highlighting
✓ Includes a text editor and code preview component
✗ Still requires some configuration, and it can be tricky

Motivation

Good documentation is key to any successful open source project, but it can be difficult to put together a good documentation site. doc-components can help.

Installation

Install using npm:

npm install doc-components

or yarn:

yarn doc-components

Getting Started

First, scaffold out an application using create-react-app.

npx create-react-app my-app
cd my-app
npm start

The doc-components are designed to be used within the out-of-the-box create-react-app build system.

Components

There are four doc-components.

<Markdown />

Documentation coming soon.

<Editor />

Documentation coming soon.

<Preview />

Documentation coming soon.

<CodeManager />

Documentation coming soon.