.

Author: DerGoogler

.github/workflows/deploy-website.yml

@@ -0,0 +1,63 @@
+name: Deploy Website
+
+on:
+  push:
+    branches:
+      - main
+      - website
+    paths:
+      - '.github/workflows/deploy-website.yml'
+      - '**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./website
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: website/yarn.lock
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build with VitePress
+        run: |
+          yarn docs:build
+          touch docs/.vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,150 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# from: https://github.com/vuejs/vitepress/blob/main/.gitignore
+/coverage
+/src/client/shared.ts
+/src/node/shared.ts
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode
+dist
+cache
+examples-temp
+node_modules
+pnpm-global
+TODOs.md
+
+cache

docs/.vitepress/config.ts

@@ -0,0 +1,10 @@
+import { defineConfig, SiteConfig } from 'vitepress'
+import locales from './locales'
+
+export default defineConfig( {
+    title: 'MMRL',
+    locales: locales.locales,
+    sitemap: {
+        hostname: 'https://mmrlapp.github.io'
+    },
+})

docs/.vitepress/locales/en.ts

@@ -0,0 +1,67 @@
+import { createRequire } from 'module'
+import { defineConfig } from 'vitepress'
+
+const require = createRequire(import.meta.url)
+const pkg = require('vitepress/package.json')
+
+export default defineConfig({
+  lang: 'en-US',
+  description: 'Build your own modules repository',
+
+  themeConfig: {
+    nav: nav(),
+
+    lastUpdatedText: 'last Updated',
+
+    sidebar: {
+      '/guide/': sidebarGuide(),
+      '/home/': sidebarHome()
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/MMRLApp/MMRL' },
+      { icon: 'googleplay', link: 'https://play.google.com/store/apps/details?id=com.dergoogler.mmrl' }
+    ],
+
+    footer: {
+        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'
+    }
+  }
+})
+
+function nav() {
+  return [
+    { text: 'Home', link: '/home/repositories' },
+    { text: 'Guide', link: '/guide/index' },
+  ]
+}
+
+function sidebarGuide() {
+  return [
+    {
+        text: 'Guide',
+        items: [
+          { text: 'Module WebUI', link: '/guide/module-webui.md' },
+          { text: 'FAQ', link: '/guide/faq' },
+        ]
+    }
+  ]
+}
+
+
+function sidebarHome() {
+  return [
+    {
+        text: 'Home',
+        items: [
+          { text: 'Repositories', link: '/home/repositories' },
+        ]
+    }
+  ]
+}

docs/.vitepress/locales/index.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitepress'
+import en from './en'
+
+export default defineConfig({
+  locales: {
+    root: {
+      label: 'English',
+      lang: en.lang,
+      themeConfig: en.themeConfig,
+      description: en.description
+    }
+  }
+})

docs/guide/faq.md

@@ -0,0 +1,9 @@
+# FAQ
+
+## How to enable JavaScript APIs in MMR?
+
+**above v5.32.43**
+Go to Settings > Modules & Permission > {module} > Check any of the both options
+
+**below v5.32.43**
+Go to Settings > Security > Allow JavaScript API > {module} > Check any of the both options

docs/guide/index.md

@@ -0,0 +1 @@
+_Nothing to see here bro 🤓_

docs/guide/module-webui.md

@@ -0,0 +1,57 @@
+# Module WebUI
+
+In addition to executing boot scripts and modifying system files, KernelSU's modules also support displaying UI interfaces and interacting with users.
+
+The module can write HTML + CSS + JavaScript pages through any web technology. KernelSU's manager will display these pages through WebView. It also provides some APIs for interacting with the system, such as executing shell commands.
+
+## `webroot` directory
+
+Web resource files should be placed in the `webroot` subdirectory of the module root directory, and there **MUST** be a file named `index.html`, which is the module page entry. The simplest module structure containing a web interface is as follows:
+
+```txt
+❯ tree .
+.
+|-- module.prop
+`-- webroot
+    `-- index.html
+```
+
+:::warning
+When installing the module, KernelSU will automatically set the permissions and SELinux context of this directory. If you do not know what you are doing, please do not set the permissions of this directory yourself!
+:::
+
+If your page contains CSS and JavaScript, you need to place it in this directory as well.
+
+## JavaScript API
+
+If it is just a display page, it is no different from a normal web page. More importantly, KernelSU provides a series of system API that allows you to implement the unique functions of the module.
+
+KernelSU provides a JavaScript library and [publishes it on npm](https://www.npmjs.com/package/kernelsu), which you can use in the JavaScript code of your web pages.
+MMRL also provides a JavaScript library and [publishes it on npm](https://www.npmjs.com/package/mmrl)
+
+For example, you can execute a shell command to obtain a specific configuration or modify a property:
+
+```JavaScript
+import { exec } from 'kernelsu';
+
+const { errno, stdout } = exec("getprop ro.product.model");
+```
+
+```JavaScript
+import { MMRLInterfaceFactory } from "mmrl";
+
+const module = MMRLInterfaceFactory("net-switch");
+module.injectStyleSheets();
+console.log(module.manager);
+```
+
+For another example, you can make the web page display full screen, or display a toast.
+
+[API documentation](https://www.npmjs.com/package/kernelsu).
+
+If you find that the existing API does not meet your needs or is inconvenient to use, you are welcome to give us suggestions [here](https://github.com/tiann/KernelSU/issues)!
+
+## Some tips
+
+1. You can use `localStorage` normally to store some data, but it will be lost after the manager app is uninstalled. If you need to save persistently, you can write data to a custom directory yourself.
+2. For simple pages, I recommend you use [parceljs](https://parceljs.org/) for packaging. It requires zero configuration and is very convenient to use. However, if you are a front-end master or have your own preferences, then just choose the one you like!