Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docsifyjs/docsify-cli

🖌 docsify cli tool - A magical documentation generator.
https://github.com/docsifyjs/docsify-cli

docsify docsify-cli javascript nodejs

Last synced: about 3 hours ago
JSON representation

🖌 docsify cli tool - A magical documentation generator.

Host: GitHub
URL: https://github.com/docsifyjs/docsify-cli
Owner: docsifyjs
License: mit
Created: 2016-11-22T14:50:41.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-09-26T22:14:50.000Z (about 1 month ago)
Last Synced: 2024-10-30T00:00:30.389Z (10 days ago)
Topics: docsify, docsify-cli, javascript, nodejs
Language: JavaScript
Homepage: https://cli.docsifyjs.org
Size: 1.29 MB
Stars: 711
Watchers: 21
Forks: 153
Open Issues: 25
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - docsifyjs/docsify-cli - 🖌 docsify cli tool - A magical documentation generator. (nodejs)

README

        


  

    

  





 🖌 docsify cli - A magical documentation generator.





  

  

  

  











Gold Sponsor via Open Collective




  

    

  



## Screencast

![Screencast](https://raw.githubusercontent.com/docsifyjs/docsify-cli/master/media/screencast.gif)

> Running a server on `localhost` with live-reload.

## Installation

Install `docsify-cli` via `npm` or `yarn` globally.

```shell

npm i docsify-cli -g

# yarn global add docsify-cli

```

## Usage

### `init` command

Use `init` to generate your docs.

```shell

docsify init [path] [--local false] [--theme vue] [--plugins false]

# docsify i [path] [-l false] [-t vue] [--plugins false]

```

`[path]` defaults to the current directory. Use relative paths like `./docs` (or `docs`).

- `--local` option:

  - Shorthand: `-l`

  - Type: boolean

  - Default: `false`

  - Description: Copy `docsify` files to the docs path, defaults to `false` using `cdn.jsdelivr.net` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.

- `--theme` option:

  - Shorthand: `-t`

  - Type: string

  - Default: `vue`

  - Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.

- `--plugins` option:

  - Shorthand: `-p`

  - Type: boolean

  - Default: `false`

  - Description: Provide a list of plugins to insert as `` tags to `index.html`.

### `serve` command

Run a server on `localhost` with livereload.

```shell

docsify serve [path] [--open false] [--port 3000]

# docsify s [path] [-o false] [-p 3000]

```

- `--open` option:

  - Shorthand: `-o`

  - Type: boolean

  - Default: `false`

  - Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.

- `--port` option:

  - Shorthand: `-p`

  - Type: number

  - Default: `3000`

  - Description: Choose a listen port, defaults to `3000`.

### `generate` command

Docsify's generators.

```shell

docsify generate [path] [--sidebar _sidebar.md] [--overwrite]

# docsify g [path] [-s _sidebar.md] [-o]

```

- `--sidebar` option:

  - Shorthand: `-s`

  - Type: string

  - Default: `_sidebar.md`

  - Description: Generate sidebar file, defaults to `_sidebar.md`.

- `--overwrite` option:

  - Shorthand: `-o`

  - Type: boolean

  - Default: `false`

  - Description: Allow overwrite generated files.

## Contributing

Please see the [Contributing Guidelines](./CONTRIBUTING.md)

## Contribution

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify-cli)

## License

[MIT](LICENSE)