docula-ui-react

Docula-UI-React (https://docu.la)

Docula is a knowledge base system based on open technologies. Keep your data in GitHub, but still have a rich UI, search and other services.

Features

• GitHub repository cloning and change detection.
• Documentation files in Markdown
• API documentation files in OpenAPI Json or YAML
• Category-based organization of supported documentation.
• Organizing metadata model in Redis data store.
• Storing files content in Redis file store.
• Indexing files content in ElasticSearch.
• Providing necessary node.js programming layout to build external APIs or User Interfaces.
• Providing React-base UI application for read access to a repository.
• Providing support for easy integration into existing Express.js based web sites.

Docula-UI-React provides React.js components for a Docula user interface

Other Docula modules:

• Docula-Core - core functionality to build services based on Docula
• Docula-UI-Express - a glue for other modules to make including Docula to your node.js Express-based website a one-liner

Installation

Using as part of Docula-UI-Express

See Docula-UI-Express.

Static build to serve from a CDN

To be done...

Configuration

Docula React UI expects configuration object defined in global (window) scope. Usually it is done by inserting javascript into document body at compile time.

Usually this is done by a helper module like docula-ui-express. See documentation on this object there.