docs: Update Documentation (#2194)

This commit is contained in:
7ui77
2026-05-18 11:52:43 +07:00
committed by GitHub
parent 16b0dd5bf7
commit 5e195b7f53
4 changed files with 676 additions and 670 deletions
+642 -636
View File
File diff suppressed because it is too large Load Diff
+30 -30
View File
@@ -1,30 +1,30 @@
# Quick start
1. [Requirements](#requirements)
2. [Single plugin guide](#quick-guide)
3. [Multi-src guide](#creating-multi-src-plugins)
### Requirements
- [git](https://git-scm.com/doc/ext) basics
- Typescript or Javascript basics
- Node >=18
- Installing the dependencies with `npm i`
### Guide
1. Create plugin script in `/plugins` [<span style="font-size: 0.8rem;">(learn more)</span>](#creating-plugin-script)
2. Copy code from [plugin-template.ts](./plugin-template.ts)
3. Start coding [<span style="font-size:0.8rem">(documentation)</span>](./docs.md)
#### Creating plugin script
1. Remember to create your plugin inside the language folder corresponding to the language of the novels
2. File should have the `.ts` extension
Example `plugins/english/nobleMTL.ts`
3. Add an icon to `icons/src/<lang>/<plugin-name>/icon.png`
> [!WARNING]
> Icon size should be 96x96px!
### Creating multi-source plugins
# Quick start
1. [Requirements](#requirements)
2. [Single plugin guide](#quick-guide)
3. [Multi-src guide](#creating-multi-src-plugins)
### Requirements
- [git](https://git-scm.com/doc/ext) basics
- Typescript or Javascript basics
- Node >=22
- Installing the dependencies with `npm i`
### Guide
1. Create plugin script in `/plugins` [<span style="font-size: 0.8rem;">(learn more)</span>](#creating-plugin-script)
2. Copy code from [plugin-template.ts](./plugin-template.ts)
3. Start coding [<span style="font-size:0.8rem">(documentation)</span>](./docs.md)
#### Creating plugin script
1. Remember to create your plugin inside the language folder corresponding to the language of the novels
2. File should have the `.ts` extension
Example `plugins/english/nobleMTL.ts`
3. Add an icon to `public/static/src/<lang>/<plugin-name>/icon.png`
> [!WARNING]
> Icon size should be 96x96px!
### Creating multi-source plugins
+3 -3
View File
@@ -23,12 +23,12 @@ The testing website provides five main sections to test different plugin functio
- **Headers** - Configure custom HTTP headers
- **Popular Novels** - Test `popularNovels()` with pagination and filters
- **Search Novels** - Test `searchNovels()` with search queries
- **Parse Novel** - Test `parseNovel()` with a novel URL
- **Parse Chapter** - Test `parseChapter()` with a chapter URL
- **Parse Novel** - Test `parseNovel()` with a novel path
- **Parse Chapter** - Test `parseChapter()` with a chapter path
## Pre-Submission Testing
Before submitting your plugin, verify that all five sections work without errors, multiple pages load, search returns accurate results, novel parsing extracts all metadata, chapter content is clean, filters work (if implemented), no console errors appear, URLs are properly formatted, and images load correctly.
Before submitting your plugin, verify that all five sections work without errors, multiple pages load, search returns accurate results, novel parsing extracts all metadata, chapter content is clean, filters work (if implemented), no console errors appear, paths are properly formatted, and images load correctly.
## Need Help?