# docula-ui-react

> React UI components of Docula project

Latest version **0.0.28** (published 2017-01-03) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install docula-ui-react
pnpm add docula-ui-react
yarn add docula-ui-react
bun add docula-ui-react
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.28 |
| Published | 2017-01-03 |
| First published | 2016-10-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=5.9.1 |
| Dependencies | 24 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | jaredwray |

## Links

- npm: https://www.npmjs.com/package/docula-ui-react
- npm.io page: https://npm.io/package/docula-ui-react

## Dependencies (24)

- [q](https://npm.io/package/q.md) latest
- [react](https://npm.io/package/react.md) ^15.3.2
- [redux](https://npm.io/package/redux.md) latest
- [jquery](https://npm.io/package/jquery.md) ^3.1.1
- [history](https://npm.io/package/history.md) ^2.0.0
- [react-ga](https://npm.io/package/react-ga.md) ^2.1.2
- [url-join](https://npm.io/package/url-join.md) ^1.1.0
- [node-sass](https://npm.io/package/node-sass.md) ^3.8.0
- [react-dom](https://npm.io/package/react-dom.md) ^15.3.2
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [react-redux](https://npm.io/package/react-redux.md) latest
- [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.1.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.7.0
- [query-string](https://npm.io/package/query-string.md) ^4.2.3
- [react-router](https://npm.io/package/react-router.md) latest
- [react-scroll](https://npm.io/package/react-scroll.md) ^1.4.0
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) latest
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.13.0
- [react-waypoint](https://npm.io/package/react-waypoint.md) ^3.1.3
- [redux-debounce](https://npm.io/package/redux-debounce.md) ^1.0.1
- [react-highlight](https://npm.io/package/react-highlight.md) ^0.8.0
- [react-remarkable](https://npm.io/package/react-remarkable.md) ^1.1.1
- [react-disqus-thread](https://npm.io/package/react-disqus-thread.md) ^0.4.0
- [redux-devtools-extension](https://npm.io/package/redux-devtools-extension.md) ^1.0.0

## Recent versions

- 0.0.28 (latest) — 2017-01-03
- 0.0.25 — 2016-11-30
- 0.0.21 — 2016-11-09
- 0.0.20 — 2016-11-04
- 0.0.19 — 2016-10-30
- 0.0.10 — 2016-10-21
- 0.0.9 — 2016-10-19

## README

# 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](https://openapis.org/) 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](https://github.com/jaredwray/docula-core) - core functionality to build services based on Docula
* [Docula-UI-Express](https://github.com/jaredwray/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](https://github.com/jaredwray/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.

---
_Source: https://npm.io/package/docula-ui-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._