# tikuidoc-tikui

> Tikui documentation

Latest version **9.0.1** (published 2026-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install tikuidoc-tikui
pnpm add tikuidoc-tikui
yarn add tikuidoc-tikui
bun add tikuidoc-tikui
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 9.0.1 |
| Published | 2026-01-21 |
| First published | 2019-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 0 |
| Unpacked size | 3.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | Anthony Rey |
| Maintainers | anrey, nonomoho |

## Links

- npm: https://www.npmjs.com/package/tikuidoc-tikui
- Repository: https://github.com/tikui/tikuidoc-tikui
- Homepage: https://github.com/tikui/tikuidoc-tikui#readme
- Issues: https://github.com/tikui/tikuidoc-tikui/issues
- npm.io page: https://npm.io/package/tikuidoc-tikui

## Recent versions

- 9.0.1 (latest) — 2026-01-21
- 6.0.0-alpha.1 (alpha) — 2024-07-25
- 9.0.0 — 2025-09-06
- 8.0.1 — 2024-12-17
- 8.0.0 — 2024-08-23
- 7.0.1 — 2024-08-16
- 7.0.0 — 2024-08-06
- 6.0.0 — 2024-07-25
- 6.0.0-alpha.0 — 2024-07-24
- 5.0.2 — 2023-01-12
- 5.0.2-alpha.0 — 2022-12-16
- 5.0.1 — 2022-10-12
- 5.0.0 — 2022-09-07
- 4.0.0 — 2022-07-25
- 4.0.0-alpha.0 — 2022-07-25
- … 25 more at https://npm.io/package/tikuidoc-tikui/versions

## README

# Tikui documentation

This is the official Tikui documentation module.

## Create a documentation module

If you want to create your own module, please name it `tikuidoc-$MODULE_NAME` where `MODULE_NAME` is the name of your module.

Then you can clone this module as a reference and change files you want (don't forget to change `package.json` to make your style and then you should publish it on the official node package registry using `npm publish`.

## Consume a tikui module

To use a module, you should install it on your Tikui project using the latest version from `@tikui/tikui-core` (or by generating it using `@tikui/cli`) and then you have to edit the `tikuiconfig.json` to set the documentation name like your `$MODULE_NAME`.

Here is an example for a module named `tikuidoc-tikui`:

```json
{
  "documentation": "tikui"
}
```

Then you can do exactly what you do with a standard Tikui project.

## About

Initially, Bootstrap was needed to make the documentation work. Now we have a dedicated style but if you still want to use the Bootstrap one, you may need to install `tikuidoc-bootstrap` and change `tikui` by `bootstrap` in your `tikuiconfig.json`.

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