add-sources Documentation

Official TypeScript developer resources and documentation for gedoor/add-sources. Verified technical context for AI.

0 stars TypeScript TypeScript 1 file · ~2,211 tokens
RAW Doc

1. Project Overview & Quickstart (gedoor/add-sources)

add-sources

Open-source repository gedoor/add-sources

Repository Details

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (gedoor/gedoor.github.io)

File: README.md

开源阅读官网

  • 该网站是使用现代静态网站生成器 Docusaurus 2 构建的。
  • 阅读APP项目地址 - Github

贡献

向网站贡献内容

你可以专注于内容创作，只需编写 Markdown 文件即可。

网站目录结构

text
gedoor.github.io  #网站的根目录
├──blog  #博客
│   ├── 2022-08-01-book-source.md  #八月书源更新
│   ├── authors.yaml  #作者信息
│   └── ...
├──docs  #文档
│   ├── GettingStarted.md  #入门
│   └── ...
├──src
│   └──pages  #独立页面
│       ├── download.md  #下载
│       └── ...
├── docusaurus.config.js  #网站配置
├── ...

帮助我们改进网站

安装阅读官网

Docusaurus 本质上是一组 npm 包。

要求

  • Node.js

    • v16.14 或以上版本（你可以运行 node -v 命令查看版本号）。

    • 你可以用 nvm 来管理同一机器上的多个 Node 版本。

    • 安装 Node.js 时，建议勾选所有和依赖相关的选项。

流程

1.将项目克隆到本地

您也可以使用 Github 桌面客户端

  1. 复刻仓库

  2. 克隆复刻

2.运行开发服务器

要实时预览你的编辑，你可以运行本地开发服务器。它会部署网站，并反映最新更改。

  1. 在 gedoor.github.io 文件夹空白处按下 Shift + 右键 ，选择 在终端打开 。

  2. 在 Windows PowerShell 中运行下面代码：

    text
    npm run start

默认情况下，浏览器会自动打开 http://localhost:3000 的新窗口。

恭喜！ 你刚刚成功运行了网站！ 四处逛逛，并对其改进。

3.提交代码

  1. 创建和推送更改

  2. 创建拉取请求

File: docs/get-started-quickly/add-book.md

title: 添加本地小说 sidebar_position: 1

import Giscus from '@giscus/react';

添加本地小说或导入书源

第一次使用开源阅读?

安装

您可以前往我们的 下载 页面下载最新版本的开源阅读。

:::info 为什么第一次安装好之后什么东西都没有?
阅读只是一个转码工具，不提供内容，第一次安装app，需要自己手动导入书源。
:::

给予阅读专属文件夹"Read"

:::caution 警告
(本教程环境为：Pixel 5-Android 12)

在较新 Android 版本上，您可能需要提供专属文件夹才能导入书源、添加小说、使用字体。
:::

  1. 书架界面（也就是打开应用后的第一个界面）最右上角三个点 ⋮ 图标，然后点击添加本地。
  2. 此时会弹出一个“选择文件夹”，我们使用“系统文件夹选择器”
  3. 请新建一个名为 Read 的文件夹，当然您也可以凭自己喜好命名。
  4. 选择 Read 文件夹，并点击 使用此文件夹 ，系统会提示允许阅读访问 Read 中的文件吗，我们点击允许。

添加小说到书架

  1. 首先您需要把小说文本文件存放在 Read 文件夹里。
  2. 在阅读添加本地的界面，勾选您要添加的小说。
  3. 最后点击右下方的“放入书架”，完成。

讨论

File: docs/get-started-quickly/add-sources.md

title: 导入书源 sidebar_position: 2

import Giscus from '@giscus/react';

:::info 什么是书源
简单理解就是书籍资源的网络来源。众所周知，网络上存在许许多多或收费或免费的读书网站。然而，这些网站往往存在广告繁多、排版字体欠佳，对手机优化很差等情况。书源就是通过特定的规则，在网络上抓取书籍章节和内容，并干净整齐的呈现在手机屏幕上，优化阅读体验。
:::

本地导入

  1. 添加书源文件到 Read 文件夹。
  2. 导航栏“我的”界面，进入“书源管理”。
  3. 点击右上角三个点 ⋮ 的图标，选择 本地导入 。
  4. 在系统文件选择器里，点击您要添加的书源文件。
  5. 加载完成后，勾选书源或直接全选后确定，完成。

:::tip 提示
一般书源分两种导入情况，本地文件和网络链接。
书源格式后缀有 txt、json ，其中 json 文件某些情况下无法导入，需要修改后缀为txt格式才可导入
:::

网络导入

  1. 导航栏 我的 界面，进入 书源管理 。
  2. 点击右上角三个点 ⋮ 的图标，选择 网络导入 。
  3. 粘贴书源网址后点击确定。
  4. 加载完成后，勾选书源或直接全选后确定，完成。

:::tip 提示
网路导入地址一般为:https://域名/**.json
:::

讨论

File: docs/get-started-quickly/search-book.md

title: 搜索一本书 sidebar_position: 3

import Giscus from '@giscus/react';

搜索一本书

在书架页面的搜索框内填入关键词

  1. 书架页面右上角点击 🔍 图标，进入搜书页面。
  2. 在顶部的输入框内输入 书名 或者 作者 。

从书源搜索

:::note 笔记
在**上一节**您已经添加了所需的书源，它将显示在软件主页 我的-书源管理 中。
:::

  1. 完成填入关键词
  2. 点击右边的 󠁽󠁽> 图标以开始搜索。

您大概已经找到了想看的书，请单击它，然后按左下角的 放入书架 按钮，它现在应该出现在您的 书架 页面了，准备好去阅读！

:::info 提示
列表将会以您输入的内容匹配度较高或内容较全的方式排列。
:::

:::info 搜索将会持续进行
直到所有书源搜索完毕或手动点击右下角 ⬜ 按钮停止搜索。
:::

:::caution 为什么没有搜到想要的书
请检查您输入的关键词是否正确，否则是您添加的书源没有这本书，请更换书源再重试。
:::

从书架搜索

  1. 填入关键词

  2. 此时输入框下面会显示 书架 标签，里面包含匹配关键词的书名。

  3. 点击出现的书名按钮，按下右下角的 阅读 按钮去阅读！

讨论

File: docs/donate.md

title: 捐助 sidebar_position: 9

import Giscus from '@giscus/react';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import GroupBuy from './img/donate/GroupBuy.jpg'
import zfbhbrwm from './img/donate/zfbhbrwm.png'
import zfbskrwm from './img/donate/zfbskrwm.jpg'
import wxskrwm from './img/donate/wxskrwm.jpg'
import qqskrwm from './img/donate/qqskrwm.jpg'

首先还是说一下，这个团购是我们自己摸索出来自力更生的一条路，原因很简单，我们确实接不到什么优质广告了，但也坚决不会考虑去在APP上加任何东西，所以就只能靠团购了。 目前来看，我们的选择和坚持是正确的。 一个是目前我们我们的团购已经稳定运作10多个月了，不论是选品还是售后都非常靠谱。而且都是我们自己在做，尽可能的会考虑大家的需求和利益。 再就是也有不少人依然保持着质疑，但有更多的人愿意相信我们，并且给予了我们足够的支持，有不少大佬甚至已经参团200多次了，说实话真的很感动。

使用微信扫一扫订阅

最后说一下几点重要的

  1. 这个团购是阅读自营，厂家直发的，请相信我们的人品。
  2. 团购产品都是我们自己试用或者有官方保障的产品。
  3. 任何售后问题都可以来找我们，绝对比淘宝靠谱。
  4. 店铺小二是十一，大家多耐心一点，有时候会比较忙，没法及时回复大家。
  5. 最后感谢所有下单支持我们的人，我们一定会继续加油！

讨论

File: docs/GettingStarted.md

title: 入门 sidebar_position: 1

import Giscus from '@giscus/react';

安装

您可以前往我们的 下载 页面下载最新版本的开源阅读。

添加资源

现在安装了开源阅读，你可以选择 从本地添加小说 或 导入书源 的两种方式。在此之前请按照以下步骤操作：

给予阅读专属文件夹"Read"

:::caution 警告

(本教程环境为：Pixel 5-Android 12)

在较新 Android 版本上，您需要提供专属文件夹才能导入书源、添加小说、使用字体。

:::

  1. 书架界面（也就是打开应用后的第一个界面）最右上角三个点 ⋮ 图标，然后点击添加本地。
  2. 此时会弹出一个“选择文件夹”，我们使用“系统文件夹选择器”
  3. 请新建一个名为 Read 的文件夹。
    • 该 Read 文件夹位于手机内部存储或外部SD卡的根目录下。
    • 您可以将 Read 文件夹以自己喜好重命名。
  4. 选择 Read 文件夹，并点击 使用此文件夹 ，系统会提示允许阅读访问 Read 中的文件吗，点击允许。

文件夹结构

开源阅读 需要建立特定的文件夹结构才能更好的添加资源。本地小说将从 Read 文件夹读取。

您可以参考以下示例：

html title="设备内部存储或外部sd卡的根目录"
Read	#阅读资源根目录
├── 排版配置
│   └── 舒适阅读排版.zip
├── 主题
│   ├── 白天
│	│	├──	封面.png
│	│	├──	阅读背景.jpg
│	│	└──	主题背景.jpg
│   └── 夜间
│		├──	封面.png
│		├──	阅读背景.jpg
│	 	└──	主题背景.jpg
├── 字体
│   └── 方正屏显雅宋.TTF
├──	老人与海.txt
├──	言叶之庭.epub
└──	书源.json

从本地添加小说

:::info 提示
请确保您已 给予阅读专属文件夹"Read" 。

:::

添加小说到书架

  1. 首先您需要把小说文本文件存放在 Read 文件夹里。
  2. 在阅读添加本地的界面，勾选您要添加的小说。
  3. 最后点击右下方的 放入书架 ，完成。

导入书源

:::info 什么是书源？
简单理解就是书籍资源的网络来源。众所周知，网络上存在许许多多或收费或免费的读书网站。然而，这些网站往往存在广告繁多、排版字体欠佳，对手机优化很差等情况。书源就是通过特定的规则，在网络上抓取书籍章节和内容，并干净整齐的呈现在手机屏幕上，优化阅读体验。
:::

从本地导入书源

:::info 提示
请确保您已 给予阅读专属文件夹"Read" 。

:::

  1. 添加书源文件到 Read 文件夹。
  2. 导航栏“我的”界面，进入“书源管理”。
  3. 点击右上角三个点 ⋮ 的图标，选择 本地导入 。
  4. 在系统文件选择器里，点击您要添加的书源文件。
  5. 加载完成后，勾选书源或直接全选后确定，完成。

:::tip 提示
一般书源分两种导入情况，本地文件和网络链接。
书源格式后缀有 txt、json ，其中 json 文件某些情况下无法导入，需要修改后缀为txt格式才可导入
:::

网络导入

  1. 导航栏 我的 界面，进入 书源管理 。
  2. 点击右上角三个点 ⋮ 的图标，选择 网络导入 。
  3. 粘贴书源网址后点击确定。
  4. 加载完成后，勾选书源或直接全选后确定，完成。

:::tip 提示
网路导入地址一般为:https://域名/**.json
:::

讨论

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →