头像

ISTU 文档

开发文档 · 使用指南 · API 参考

快速开始

欢迎使用 ISTU 学习资料库!本指南将帮助你快速了解如何使用这个平台。

第一步:浏览资源

在首页可以看到所有分类的学习资源,包括编程开发、系统架构、数据库、前端开发和 AI/机器学习。

第二步:搜索筛选

使用搜索框或快速筛选标签找到你需要的资源。支持按收藏、下载、视频、PDF 等类型筛选。

第三步:收藏管理

点击心形图标收藏你喜欢的资源,收藏数据会保存在本地,方便下次访问。

安装指南

克隆项目

git clone https://github.com/yourusername/istu-yun.git

安装依赖

npm install

启动开发服务器

npm run dev

配置说明

添加新资源

在 index.html 的 script 部分使用以下函数添加资源:

addLink('category', 'title', 'url', 'description', 'icon')

添加下载文件

使用以下函数添加可下载的文件:

addDownloadFile('category', 'title', 'filename', 'description', 'icon', 'size')

API 参考

函数名 参数 描述
addLink() category, title, url, description, icon 添加外部链接资源
addDownloadFile() category, title, filename, description, icon, size 添加可下载文件
filterLinks() - 搜索过滤资源
toggleFavorite() id 切换收藏状态

示例代码

添加 GitHub 链接

addLink('programming', 'GitHub', 'https://github.com/', 
  '全球最大的代码托管平台', 'fa-github')

添加 PDF 文件

addDownloadFile('programming', 'Python 学习笔记', 
  'python笔记.pdf', 'Python 基础语法总结', 
  'fa-file-pdf', '2.5 MB')

常见问题

Q: 如何自定义主题颜色?

A: 在 index.html 的 tailwind.config 中修改 colors 配置即可自定义主题颜色。

Q: 收藏的数据保存在哪里?

A: 收藏数据使用 localStorage 保存在浏览器本地,不会上传到服务器。

Q: 如何部署到 Cloudflare Pages?

A: 使用命令 npx wrangler pages deploy . --project-name istu-yun 即可部署。