Skip to content

Commit ae1fca6

Browse files
committed
chore(readme): added banner image and badges
1 parent caf24ae commit ae1fca6

File tree

2 files changed

+80
-29
lines changed

2 files changed

+80
-29
lines changed

README.md

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,38 @@
11
# docsify-cli
22

3-
[![Build Status master branch](https://img.shields.io/travis/docsifyjs/docsify-cli/master.svg?style=flat-square)](https://travis-ci.org/docsifyjs/docsify-cli)
4-
[![License](https://img.shields.io/github/license/docsifyjs/docsify-cli.svg?style=flat-square)](https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE)
5-
[![Github tag](https://img.shields.io/github/tag/docsifyjs/docsify-cli.svg?style=flat-square)](https://github.com/docsifyjs/docsify-cli/tags)
6-
[![npm version](https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
7-
[![npm total downloads](https://img.shields.io/npm/dt/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
8-
[![npm total monthly](https://img.shields.io/npm/dm/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
9-
10-
> 🖌 docsify cli - A magical documentation generator.
3+
<p align="center">
4+
<a href="https://docsify.js.org">
5+
<img alt="docsify" src="./media/icon.svg">
6+
</a>
7+
</p>
8+
9+
<p align="center">
10+
🖌 docsify cli - A magical documentation generator.
11+
</p>
12+
13+
<p align="center">
14+
<a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
15+
<a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
16+
<a href="https://travis-ci.org/docsifyjs/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/docsifyjs/docsify-cli/master.svg?style=flat-square"></a>
17+
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square"></a>
18+
<a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
19+
<a href="https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE"><img alt="license" src="https://img.shields.io/github/license/docsifyjs/docsify-cli.svg?style=flat-square"></a>
20+
<a href="https://www.npmjs.com/package/docsify-cli"><img alt="npm-total-download" src="https://img.shields.io/npm/dt/docsify-cli.svg?style=flat-square"></a>
21+
<a href="https://www.npmjs.com/package/docsify-cli"><img alt="npm-monthly-download" src="https://img.shields.io/npm/dm/docsify-cli.svg?style=flat-square"></a>
22+
23+
</p>
24+
25+
<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
26+
27+
<p align="center">
28+
<a href="https://opencollective.com/docsify/order/3254">
29+
<img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
30+
</a>
31+
</p>
1132

1233
## Links
1334

14-
* [docsify](https://github.com/QingWei-Li/docsify)
35+
- [docsify](https://github.com/QingWei-Li/docsify)
1536

1637
## Screencast
1738

@@ -42,16 +63,16 @@ docsify init <path> [--local false] [--theme vue]
4263

4364
`<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
4465

45-
* `--local` option:
46-
* Shorthand: `-l`
47-
* Type: boolean
48-
* Default: `false`
49-
* Description: Copy `docsify` files to the docs path, defaults to `false` using `unpkg.com` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
50-
* `--theme` option:
51-
* Shorthand: `-t`
52-
* Type: string
53-
* Default: `vue`
54-
* Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
66+
- `--local` option:
67+
- Shorthand: `-l`
68+
- Type: boolean
69+
- Default: `false`
70+
- Description: Copy `docsify` files to the docs path, defaults to `false` using `unpkg.com` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
71+
- `--theme` option:
72+
- Shorthand: `-t`
73+
- Type: string
74+
- Default: `vue`
75+
- Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
5576

5677
### `serve` command
5778

@@ -63,16 +84,16 @@ docsify serve <path> [--open false] [--port 3000]
6384
# docsify s <path> [--open false] [--port 3000]
6485
```
6586

66-
* `--open` option:
67-
* Shorthand: `-o`
68-
* Type: boolean
69-
* Default: `false`
70-
* Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
71-
* `--port` option:
72-
* Shorthand: `-p`
73-
* Type: number
74-
* Default: `3000`
75-
* Description: Choose a listen port, defaults to `3000`.
87+
- `--open` option:
88+
- Shorthand: `-o`
89+
- Type: boolean
90+
- Default: `false`
91+
- Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
92+
- `--port` option:
93+
- Shorthand: `-p`
94+
- Type: number
95+
- Default: `3000`
96+
- Description: Choose a listen port, defaults to `3000`.
7697

7798
## License
7899

media/icon.svg

Lines changed: 30 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)