Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update
  • Loading branch information
sy-records committed Oct 30, 2020
commit cbb24ac1e5ce4f149670ec0182b0ec10ab0f2002
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
node_modules/
yarn.lock
bin/
.idea
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://docsify.js.org">
<img alt="docsify" src="./media/icon.svg">
<img alt="docsify" src="https://cdn.jsdelivr.net/gh/docsifyjs/docsify-cli/media/icon.svg">
</a>
</p>

Expand Down Expand Up @@ -30,7 +30,7 @@

## Screencast

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

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

Expand All @@ -50,9 +50,9 @@ npm i docsify-cli -g
Use `init` to generate your docs.

```shell
docsify init <path> [--local false] [--theme vue]
docsify init <path> [--local false] [--theme vue] [--sidebar false] [--navbar false] [--coverpage false]

# docsify i <path> [--local false] [--theme vue]
# docsify i <path> [--local false] [--theme vue] [--sidebar false] [--navbar false] [--coverpage false]
```

`<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
Expand All @@ -61,12 +61,27 @@ docsify init <path> [--local false] [--theme vue]
- Shorthand: `-l`
- Type: boolean
- Default: `false`
- 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`.
- Description: Copy `docsify` files to the docs path, defaults to `false` using `jsDelivr` 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`.
- `--sidebar` option:
* Shorthand: `-s`
* Type: boolean
* Default: `false`
* Description: Include sidebar when generating a new doc, defaults to `false`.
- `--navbar` option:
* Shorthand: `-n`
* Type: boolean
* Default: `false`
* Description: Include navbar when generating a new doc, defaults to `false`.
- `--coverpage` option:
* Shorthand: `-c`
* Type: boolean
* Default: `false`
* Description: Include coverpage when generating a new doc, defaults to `false`.

### `serve` command

Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docsify-cli

[![Build Status master branch](https://img.shields.io/travis/QingWei-Li/docsify-cli/master.svg?style=flat-square)](https://travis-ci.org/QingWei-Li/docsify-cli)
[![Build Status master branch](https://img.shields.io/travis/docsifyjs/docsify-cli/master.svg?style=flat-square)](https://travis-ci.org/docsifyjs/docsify-cli)
[![License](https://img.shields.io/github/license/QingWei-Li/docsify-cli.svg?style=flat-square)](https://github.com/QingWei-Li/docsify-cli/blob/master/LICENSE)
[![Github tag](https://img.shields.io/github/tag/QingWei-Li/docsify-cli.svg?style=flat-square)](https://github.com/QingWei-Li/docsify-cli/tags)
[![npm version](https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square)](https://www.npmjs.com/package/docsify-cli)
Expand All @@ -11,11 +11,11 @@

## Links

* [docsify](https://github.com/QingWei-Li/docsify)
* [docsify](https://github.com/docsifyjs/docsify)

## Screencast

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

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

Expand Down Expand Up @@ -46,7 +46,7 @@ docsify init <path> [--local false] [--theme vue] [--sidebar false] [--navbar fa
* Shorthand: `-l`
* Type: boolean
* Default: `false`
* 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`.
* Description: Copy `docsify` files to the docs path, defaults to `false` using `jsDelivr` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
* `--theme` option:
* Shorthand: `-t`
* Type: string
Expand Down
10 changes: 4 additions & 6 deletions lib/template/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
<!-- _coverpage.md -->
![logo](https://cdn.jsdelivr.net/gh/docsifyjs/docsify/docs/_media/icon.svg)

![logo](_media/icon.svg)

# docsify <small>3.5</small>
# docsify

> A magical documentation site generator.

- Simple and lightweight (~21kB gzipped)
- Simple and lightweight
- No statically built html files
- Multiple themes

[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#docsify)
[Getting Started](#docsify)
6 changes: 2 additions & 4 deletions lib/template/_navbar.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
<!-- _navbar.md -->

* [En](/)
* [chinese](/zh-cn/)
- Translations
- [:uk: English](/)
5 changes: 2 additions & 3 deletions lib/template/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
<!-- docs/_sidebar.md -->
- Getting started

* [Home](/)
* [Guide](guide.md)
- [Home](/)
7 changes: 5 additions & 2 deletions tools/locales/zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
"epilog": "文档地址:\n https://docsifyjs.github.io/docsify\n https://docsifyjs.github.io/docsify-cli\n\n开发:\n https://github.com/docsifyjs/docsify-cli/blob/master/CONTRIBUTING.md\n",
"group.globaloptions": "全局选项",
"help": "帮助",
"start": "Server for SSR",
"init": "创建 docs",
"start": "Server for SSR",
"init.local": "拷贝 docsify 到本地",
"init.theme": "选择主题",
"init.sidebar": "生成新文档时包含侧边栏,默认为 `false`",
"init.navbar": "生成新文档时包含导航栏,默认为 `false`",
"init.coverpage": "生成新文档时包括封面页,默认为 `false`",
"serve": "本地预览",
"serve.open": "自动打开浏览器",
"serve.port": "设置端口",
"serve.indexname": "Custom filename instead of index.html to serve by default",
"serve.indexname": "自定义首页文件名称",
"livereload.port": "设置livereload端口",
"usage": "例子",
"version": "当前版本号"
Expand Down