update

Author: DerGoogler

docs/.vitepress/config.ts

@@ -1,20 +1,25 @@
 import { defineConfig, SiteConfig } from 'vitepress'
 import locales from './locales'
 
-export default defineConfig( {
-    title: 'MMRL',
-    locales: locales.locales,
-    sitemap: {
-        hostname: 'https://mmrl.dev'
-    },
-    head: [
-        [
-            'script', 
-            { 
-                async: 'async', 
-                src: 'https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-5042729416879007',                                 
-                crossorigin: 'anonymous',                                         
-            }
-        ],                                               
-    ],
-})
+export default defineConfig(
+    {
+        markdown: {
+            lineNumbers: true
+        },
+        title: 'MMRL',
+        locales: locales.locales,
+        sitemap: {
+            hostname: 'https://mmrl.dev'
+        },
+        head: [
+            [
+                'script',
+                {
+                    async: 'async',
+                    src: 'https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-5042729416879007',
+                    crossorigin: 'anonymous',
+                }
+            ],
+        ],
+    }
+)

docs/.vitepress/locales/en.ts

@@ -24,32 +24,55 @@ export default defineConfig({
     ],
 
     footer: {
-        message: 'Released under the GPL3 License.',
-        copyright: 'Copyright © 2022-present Der_Googler and its contributors'
+      message: 'Released under the GPL3 License.',
+      copyright: 'Copyright © 2022-present Der_Googler and its contributors'
     },
 
     editLink: {
-        pattern: 'https://github.com/MMRLApp/MMRLApp.github.io/edit/master/docs/:path',
-        text: 'Edit this page on GitHub'
+      pattern: 'https://github.com/MMRLApp/MMRLApp.github.io/edit/master/docs/:path',
+      text: 'Edit this page on GitHub'
     }
   }
 })
 
 function nav() {
   return [
     { text: 'Home', link: '/home/repositories' },
-    { text: 'Guide', link: '/guide/index' },
+    { text: 'Guide', link: '/guide' },
   ]
 }
 
 function sidebarGuide() {
   return [
     {
-        text: 'Guide',
-        items: [
-          { text: 'Module WebUI', link: '/guide/module-webui.md' },
-          { text: 'FAQ', link: '/guide/faq' },
-        ]
+      text: 'Guide',
+      items: [
+        {
+          text: 'WebUI',
+          items: [
+            { text: 'Getting Started', link: '/guide/webui/' },
+            {
+              text: 'API',
+              items: [
+                { text: 'FileSystem', link: '/guide/webui/api/filesystem' },
+                { text: 'MMRLInterface', link: '/guide/webui/api/mmrlinterface' },
+                { text: 'Toast', link: '/guide/webui/api/toast' },
+                { text: 'VersionInterface', link: '/guide/webui/api/versioninterface' },
+              ]
+            },
+          ]
+        },
+        {
+          text: 'MMRL-Util',
+          items: [
+            { text: 'Getting Started', link: '/guide/mmrl-util/' },
+            { text: 'repo.json', link: '/guide/mmrl-util/repo-json' },
+            { text: 'track.json', link: '/guide/mmrl-util/track-json' },
+            { text: 'config.json', link: '/guide/mmrl-util/config-json' },
+          ]
+        },
+        { text: 'FAQ', link: '/guide/faq' },
+      ]
     }
   ]
 }
@@ -58,10 +81,10 @@ function sidebarGuide() {
 function sidebarHome() {
   return [
     {
-        text: 'Home',
-        items: [
-          { text: 'Repositories', link: '/home/repositories' },
-        ]
+      text: 'Home',
+      items: [
+        { text: 'Repositories', link: '/home/repositories' },
+      ]
     }
   ]
 }

docs/guide/mmrl-util/config-json.md

@@ -0,0 +1,87 @@
+### `config.json` Documentation
+
+This JSON configuration file contains settings related to a Magisk repository. Below is a detailed explanation of each field in the `config.json` file.
+
+---
+
+### `name` (required)
+
+The name of the repository.
+
+```json
+"name": "Template Magisk Modules Repository"
+```
+
+### `base_url` (required)
+
+The base URL for fetching repository modules and tracks. The end slash is required!
+
+```json
+"base_url": "https://example.com/"
+```
+
+### `website`
+
+The URL of the repository's website.
+
+```
+"website": "https://mmrl.dergoogler.com"
+```
+
+### `support`
+
+The URL to the support page for the repository.
+
+```json
+"support": "url"
+```
+
+### `donate`
+
+The URL where users can donate to support the repository.
+
+```json
+"donate": "url"
+```
+
+### `submission`
+
+This field allows submitting new tracks or modules to the repository.
+
+```json
+"submission": "url"
+```
+
+### `description
+
+````
+
+A brief description of the repository.
+
+```json
+"description": "url"
+````
+
+### `max_num`
+
+Specifies the maximum number of allowed modules or users that the repository can support.
+
+```json
+"max_num": 3
+```
+
+### `enable_log`
+
+A flag that enables or disables logging. Set to `true` to enable.
+
+```json
+"enable_log": true
+```
+
+### `log_dir`
+
+Specifies the directory where logs will be stored.
+
+```json
+"log_dir": "log"
+```

docs/guide/mmrl-util/index.md

@@ -0,0 +1,67 @@
+# Magisk Modules Repo Util
+
+This util is to build module repository for [MMRL](https://github.com/DerGoogler/MMRL)
+
+## Getting Started
+
+### Install dependencies
+
+```shell
+pip3 install mmrl-util
+```
+
+### New config.json
+
+You can write it to `your-repo/json/config.json` by yourself, or
+
+```shell
+cli.py config --stdin << EOF
+{
+  "name": "Your Magisk Repo",
+  "base_url": "https://you.github.io/magisk-modules-repo/",
+  "max_num": 3,
+  "enable_log": true,
+  "log_dir": "log"
+}
+EOF
+```
+
+or
+
+```shell
+cli.py config --write name="Your Magisk Repo" base_url="https://you.github.io/magisk-modules-repo/" max_num=3 enable_log=true log_dir="log"
+```
+
+## How to update by GitHub Actions?
+
+- You can refer to our [example-repository](https://github.com/Googlers-Repo/example-repository).
+
+## mmrl-util
+
+```
+mmrl-util --help
+usage: mmrl-util [-h] [-v] [-V] command ...
+
+Magisk Modules Repo Util
+
+positional arguments:
+  command
+    config            Modify config of repository.
+    track             Module tracks utility.
+    github            Generate tracks from GitHub.
+    sync              Sync modules in repository.
+    index             Generate modules.json from local.
+    check             Content check and migrate.
+    sitemap           Sitemap generator.
+
+options:
+  -h, --help          Show this help message and exit.
+  -v, --version       Show util version and exit.
+  -V, --version-code  Show util version code and exit.
+```
+
+### Learn more!
+
+- [TrackJson](./track-json)
+- [ConfigJson](./config-json)
+- [RepoJson](./repo-json)