Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anaer/anaer.github.io


https://github.com/anaer/anaer.github.io

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

## 个性化导航页面

fork from https://ljquan.github.io/

一个基于 service worker 和单页面应用(SPA)的[导航页面](https://anaer.github.io/)

## 特性

1. 静态, 可部署在 github.io 或 cdn 服务器上
2. 支持离线使用
3. 支持拼音首字母和键盘快捷键

## 使用方式

1. 把本项目 fork 一份到你的仓库,更改项目名称为`your_name.github.io`,几分钟后 Github 会自动为你开通[your_name.github.io](https://github.com/anaer/anaer.github.io)的个人主页

2. 通过 Git 的命令行(Git Bash)把 your_name.github.io 项目 clone 到本地

3. 配置文件是`./json/link.json`可以按需修改。

4. 把变更 push 到远程仓库,配置文件的改动会在第二次访问后生效。

## 部署

```yml
npm install # 安装依赖
npm start # 本地启动

gulp dev
gulp server
gulp watch
```

## FAQ

```log
Q: gulp命令执行报错, 如`gulp dev`, `gulp server`, 错误信息: ReferenceError: primordials is not defined
A: 1. NodeJS可能版本太高(当前最新: 16.8.0), 调整使用8.6.0可以执行
2. 升级gulp版本为4.x, 同时修改gulpfile.js中的过时方法
```

## link.json 说明

```json
[
{
"title": "组标题",
// 组id 通过修改groupid可以调整排序
"groupid": 1,
// 限制条目数, 默认6条
"limit": 8,
// 书签列表
"rows": ["标题(过长会显示成...) | URL链接"]
}
]
```

## 目录结构

```
json
link.json 链接配置文件
source
src
model
link.js link.json解析
card
common
linktab.js linktab模板代码
daohang.js linktab生成
navigator.js 导航条
tool
link.js 可以修改搜索框默认搜索引擎
```

## 许可

MIT