# docsify-build

> build html

Latest version **1.0.10** (published 2022-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install docsify-build
pnpm add docsify-build
yarn add docsify-build
bun add docsify-build
```

Provides the command `docsify-build`.

## 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.0.10 |
| Published | 2022-02-08 |
| First published | 2022-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 223.1 KB |
| Known vulnerabilities | 0 (+19 in 2 direct dependencies) |
| Install scripts | no |
| Author | yu |
| Maintainers | ayu-666 |

## Links

- npm: https://www.npmjs.com/package/docsify-build
- Repository: https://github.com/ayu-666/docsify-build
- Homepage: https://github.com/ayu-666/docsify-build#readme
- Issues: https://github.com/ayu-666/docsify-build/issues
- npm.io page: https://npm.io/package/docsify-build

## Dependencies (9)

- [debug](https://npm.io/package/debug.md) ^4.3.3
- [marked](https://npm.io/package/marked.md) ^1.2.9
- [docsify](https://npm.io/package/docsify.md) ^4.12.1
- [prismjs](https://npm.io/package/prismjs.md) ^1.26.0
- [dompurify](https://npm.io/package/dompurify.md) ^2.3.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.6
- [strip-indent](https://npm.io/package/strip-indent.md) ^3.0.0
- [yargs-parser](https://npm.io/package/yargs-parser.md) ^21.0.0
- [resolve-pathname](https://npm.io/package/resolve-pathname.md) ^3.0.0

## Recent versions

- 1.0.10 (latest) — 2022-02-08
- 1.0.9 — 2022-02-08
- 1.0.8 — 2022-02-08
- 1.0.7 — 2022-02-08
- 1.0.6 — 2022-02-08
- 1.0.5 — 2022-02-08
- 1.0.4 — 2022-02-08
- 1.0.3 — 2022-02-08
- 1.0.2 — 2022-02-08
- 1.0.1 — 2022-02-08
- 1.0.0 — 2022-02-08

## README

# 编译静态文件优化搜索排名-docsify编译工具

> [docsify官网](https://docsify.js.org/#/zh-cn/)
>
> [docsify简易入门](https://blog.duokan.xyz/docsify文档网站生成器/快速上手)
>
> [工具源码仓库](https://github.com/ayu-666/docsify-build)

将docsify文档每个页面编译成独立的html文件

## 安装

```bash
npm i docsify-build -g
```

or

```bash
yarn global add docsify-build
```

## 使用

```bash
docsify-build -d ./docs -o ./dist
```

## 参数列表

```
--o 输出路径 默认 ./dist
--d 文档路径 默认 ./
--t html模版路径
--c 配置文件路径
```

## 配置文件示例

```js
module.exports =  {
    name: 'name',
    repo: 'github/repository',
    routerMode: 'history',
    loadSidebar: true,
    auto2top: true
}
```
## 模版示例

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <link rel="icon" href="https://docsify.js.org/_media/favicon.ico">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
    <link rel="stylesheet" href="https://unpkg.com/docsify/themes/vue.css">
    <link rel="stylesheet" href="https://unpkg.com/docsify-toc@1.0.0/dist/toc.css">
</head>
<body>
<!--inject-app-->
<!--inject-config-->
</body>
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
<script src="/search.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
<script src="//unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>
<script src="//unpkg.com/docsify-count/dist/countable.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-python.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
</html>
<script>
    // 让每次点击都跳转(不推荐)
    // window.history.pushState = function (a,b,c){
    //     window.location.href=c
    // }
</script>
```

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