# docusee

> Docusee created for create web site with documentation from json-object

Latest version **1.2.7** (published 2021-05-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install docusee
pnpm add docusee
yarn add docusee
bun add docusee
```

Provides the command `docusee`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.7 |
| Published | 2021-05-03 |
| First published | 2021-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 672.5 KB |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Adametsofficial |
| Maintainers | adametsofficial |
| Keywords | js, docs, docs-generator, docusee, documentation, generator |

## Links

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

## Dependencies (17)

- [ejs](https://npm.io/package/ejs.md) ^3.1.6
- [clui](https://npm.io/package/clui.md) ^0.3.6
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [touch](https://npm.io/package/touch.md) ^3.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [pretty](https://npm.io/package/pretty.md) ^2.0.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [inquirer](https://npm.io/package/inquirer.md) ^8.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [jsonschema](https://npm.io/package/jsonschema.md) ^1.4.0
- [simple-git](https://npm.io/package/simple-git.md) ^2.38.0
- [configstore](https://npm.io/package/configstore.md) ^6.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^18.5.3
- [@octokit/auth-basic](https://npm.io/package/@octokit/auth-basic.md) ^1.4.8

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.7 (latest) — 2021-05-03
- 1.2.6 — 2021-05-03
- 1.2.5 — 2021-05-03
- 1.1.5 — 2021-05-03
- 1.1.3 — 2021-05-03
- 1.0.3 — 2021-05-03
- 1.0.2 — 2021-05-03
- 1.0.1 — 2021-05-02

## README

# Docusee

Docusee created for create web site with documentation from json-object

## Install

```
$ npm install -g docusee
```

## Usage

First, you need to create a file with the \* .json extension, and fill it with the template below
These fields are required

```
{
    "title": "Docusee",
    "content": [
        {
            "title": "First block title",
            "list": [
                {
                    "title": "First subblock subtitle",
                    "contetn": [
                        "your html code or plain text"
                    ]
                },
            ]
        }
    ]
}
```

Also you can add a start preview page add to the template

```
{
   "title":"Docusee",
   "preview":{
      "title":"Docusee",
      "description":"Docusee - created for example bla bla bla"
   }
   ...
}
```

---

Next, you must run the following command in the console

```
$ docusee [./path/to/your/docs.json]
```

Then next to the specified json file a folder will appear called "docs-html"

---

## Use in code

if you want to use this generator as a function, you need to do the previous step with creating a \* .json file, then perform the following

```
const docusee = require('docusee');

docusee("./path/to/your/docs.json");
```

## Orther

```
$ docusee [./path/to/your/docs.json] [-v]
```

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