docs: Update Documentation (#2194)

README.md

@@ -10,7 +10,7 @@ Community-driven plugin repository for [LNReader](https://github.com/LNReader/ln
 
 ## Quick Start
 
-**Prerequisites:** Node.js >= 20 
+**Prerequisites:** Node.js >= 22 
 
 ```bash
 npm install

docs/quickstart.md

@@ -1,30 +1,30 @@
-# Quick start
+# Quick start
-
+
-1. [Requirements](#requirements)
+1. [Requirements](#requirements)
-2. [Single plugin guide](#quick-guide)
+2. [Single plugin guide](#quick-guide)
-3. [Multi-src guide](#creating-multi-src-plugins)
+3. [Multi-src guide](#creating-multi-src-plugins)
-
+
-### Requirements
+### Requirements
-
+
--   [git](https://git-scm.com/doc/ext) basics
+-   [git](https://git-scm.com/doc/ext) basics
--   Typescript or Javascript basics
+-   Typescript or Javascript basics
--   Node >=18
+-   Node >=22
--   Installing the dependencies with `npm i`
+-   Installing the dependencies with `npm i`
-
+
-### Guide
+### Guide
-
+
-1. Create plugin script in `/plugins` [<span style="font-size: 0.8rem;">(learn more)</span>](#creating-plugin-script)
+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)
+2. Copy code from [plugin-template.ts](./plugin-template.ts)
-3. Start coding [<span style="font-size:0.8rem">(documentation)</span>](./docs.md)
+3. Start coding [<span style="font-size:0.8rem">(documentation)</span>](./docs.md)
-
+
-#### Creating plugin script
+#### Creating plugin script
-
+
-1. Remember to create your plugin inside the language folder corresponding to the language of the novels
+1. Remember to create your plugin inside the language folder corresponding to the language of the novels
-2. File should have the `.ts` extension
+2. File should have the `.ts` extension
-   Example `plugins/english/nobleMTL.ts`
+   Example `plugins/english/nobleMTL.ts`
-3. Add an icon to `icons/src/<lang>/<plugin-name>/icon.png`
+3. Add an icon to `public/static/src/<lang>/<plugin-name>/icon.png`
-
+
-> [!WARNING]
+> [!WARNING]
-> Icon size should be 96x96px!
+> Icon size should be 96x96px!
-
+
-### Creating multi-source plugins
+### Creating multi-source plugins

docs/website-tutorial.md

@@ -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 Novel** - Test `parseNovel()` with a novel path
-- **Parse Chapter** - Test `parseChapter()` with a chapter URL
+- **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?