# miniblink-simple-guide

**Repository Path**: chengyiok/miniblink-simple-guide

## Basic Information

- **Project Name**: miniblink-simple-guide
- **Description**: MiniBlink 简易指南
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://mb-simple-guide.vercel.app/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2024-08-03
- **Last Updated**: 2024-08-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MiniBlink 简易指南

## 前言

本人只是 MB 爱好者，水平有限，内容如果有任何错误、漏洞或不足，欢迎指出。

基础篇写作目标是让新手零基础入门，如果对 MB 的实现感兴趣也可以参考深入篇。

目前指南正在编写，内容见下，如果文章内部标题后有 `WIP` 表示某文档尚未完成。

Demo 预览[点击这里(需外网)](https://mb-simple-guide.vercel.app/)，如果不能访问可以直接点击下面的链接在仓库查看。

## 内容

* 基础
  * [快速开始](./docs/guide/getting-started.md)
  * [获取网页内容](./docs/guide/get-web-content.md)
  * [网络操作相关](./docs/guide/network-operation-related.md)
  * [页面操作相关](./docs/guide/page-operation-related.md)
  * [问题简易排查法](./docs/guide/troubleshooting.md)
  * [生命周期回调索引](./docs/guide/life-cycle-functions.md)
  * [功能设置相关函数索引](./docs/guide/config-functions.md)
  * [命令和事件索引](./docs/guide/commands-and-events-index.md)
* 其它功能
  * [开发者工具](./docs/guide/dev-tools.md)
  * [右键菜单控制](./docs/guide/context-menu.md)
  * [下载](./docs/guide/download.md)
  * [高 DPI 支持](./docs/guide/high-dpi.md)
  * [代理设置](./docs/guide/proxy.md)
* 深入
  * [Javascript 和 C++ 绑定如何实现](./docs/guide/how-js-binding-work.md)
  * [网络操作相关如何实现(WIP)](./docs/guide/how-net-operation-work.md)
  * 更多内容正在编写...

## 开始使用

(如果没装 yarn)
```shell
npm install --global yarn
```

第一次使用时：

```shell
yarn
```

开发环境：

```sh
yarn dev
```

打包：

```sh
yarn build
```

打包后的内容位于 `docs\.vitepress\dist`。

打包之后也可以启动一个静态服务查看显示是否正常：

```sh
yarn preview
```

## 编辑须知

修改页面内容直接修改对应的 md 文件即可，页面会自动刷新。

修改其它内容需要编辑配置文件，位置在 `docs\.vitepress\config.js`。

[vitepress 文档在这里]( https://vitepress.vuejs.org/guide/what-is-vitepress )。

编辑内容时尽量注意英文单词与中文用空格隔开(如包括 one 单词，而不是包括one单词)，这样看起来比较舒服。