# code-hlchs-examples

**Repository Path**: goldenshaw/code-hlchs-examples

## Basic Information

- **Project Name**: code-hlchs-examples
- **Description**: <<Code: The Hidden Language of Computer Hardware and Software>> 书中电路在线交互示例
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-09
- **Last Updated**: 2024-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <<编码: 隐匿在计算机软硬件背后的语言>>一书中的示例电路的线上可交互示例

## 构建
本项目使用 honkit 构建.

honkit 是 gitbook 的一个开源分支, 因 gitbook 后续的版本已经转向了闭源, 也停止了特性更新, 不支持新的 nodejs 版本, 写作过程中的热更新性能也不好或存在问题, 所以本项目没有采用 gitbook, 而是改用了 honkit.

关于 honkit 的介绍, 请参考此链接: https://honkit.netlify.app/
> 因 honkit 是从 gitbook 继承发展而来, 底层工作方式, 包括很多插件都是兼容, 理论上本项目也可能在 gitbook 下跑起来, 不过我没有充分测试过

写作阶段使用 `honkit serve` 命令查看效果, 默认地址 http://localhost:4000
> serve 情况下支持文档的热更新, 当然一些大的调整可能还是需要重启应用.
>
> 使用 `Ctrl+C` 命令可停止应用.

构建使用 `honkit build`, 生成的项目文件位于 `_book` 文件夹下.

## 线上版本
此项目部署地址: https://book.xiaogd.net/code-hlchs-examples/

## 目录说明
文档均放在 `docs` 文件夹下.

## 插件说明
去掉了自带的 `search` 插件, 改用了 `search-plus`, 支持搜索关键字的高亮.

另外增加了 "expandable-chapters-small", "anchor-navigation-ex", "bootstrap-callout2" 等几个插件.

插件通过 npm 方式安装, 在插件名称前面增加 `honkit-plugin-` 或是 `gitbook-plugin-` 比如:
```shell script
npm install honkit-plugin-search-plus
npm install gitbook-plugin-expandable-chapters-small
```

更多插件可到 npmjs 官方库去搜索.
> 注: gitbook-plugin 多数应该都能兼容, 但可能会存在一些小问题.
>
> 另: `splitter` 插件存在一些 bug, 没有使用, 因此左边的目录栏无法调整大小.

## todo
* 将复杂章节进一步细分