From 8b033c39933d55045f8ca6abb0fc3534bd4703c9 Mon Sep 17 00:00:00 2001
From: gcxfd <i@rmw.link>
Date: Mon, 21 Feb 2022 18:08:46 +0800
Subject: [PATCH] tools: add a `-theme-dir folder/` parameter to `v doc`
 (#13550)

---
 cmd/tools/vcomplete.v                         |   1 +
 cmd/tools/vdoc/html.v                         |  70 ++----------------
 cmd/tools/vdoc/{resources => theme}/arrow.svg |   0
 .../vdoc/{resources => theme}/dark-mode.js    |   0
 cmd/tools/vdoc/{resources => theme}/dark.svg  |   0
 cmd/tools/vdoc/{resources => theme}/doc.css   |   0
 cmd/tools/vdoc/{resources => theme}/doc.js    |   0
 .../favicons/android-chrome-192x192.png       | Bin
 .../favicons/android-chrome-512x512.png       | Bin
 .../favicons/apple-touch-icon.png             | Bin
 .../favicons/browserconfig.xml                |   0
 .../favicons/favicon-16x16.png                | Bin
 .../favicons/favicon-32x32.png                | Bin
 .../{resources => theme}/favicons/favicon.ico | Bin
 .../favicons/mstile-144x144.png               | Bin
 .../favicons/mstile-150x150.png               | Bin
 .../favicons/mstile-310x150.png               | Bin
 .../favicons/mstile-310x310.png               | Bin
 .../favicons/mstile-70x70.png                 | Bin
 .../favicons/safari-pinned-tab.svg            |   0
 .../favicons/site.webmanifest                 |   0
 cmd/tools/vdoc/theme/index.html               |  63 ++++++++++++++++
 cmd/tools/vdoc/{resources => theme}/light.svg |   0
 cmd/tools/vdoc/{resources => theme}/link.svg  |   0
 cmd/tools/vdoc/{resources => theme}/menu.svg  |   0
 .../vdoc/{resources => theme}/normalize.css   |   0
 cmd/tools/vdoc/vdoc.v                         |   7 ++
 cmd/v/help/doc.txt                            |   1 +
 28 files changed, 77 insertions(+), 65 deletions(-)
 rename cmd/tools/vdoc/{resources => theme}/arrow.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/dark-mode.js (100%)
 rename cmd/tools/vdoc/{resources => theme}/dark.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/doc.css (100%)
 rename cmd/tools/vdoc/{resources => theme}/doc.js (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/android-chrome-192x192.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/android-chrome-512x512.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/apple-touch-icon.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/browserconfig.xml (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/favicon-16x16.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/favicon-32x32.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/favicon.ico (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/mstile-144x144.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/mstile-150x150.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/mstile-310x150.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/mstile-310x310.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/mstile-70x70.png (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/safari-pinned-tab.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/favicons/site.webmanifest (100%)
 create mode 100644 cmd/tools/vdoc/theme/index.html
 rename cmd/tools/vdoc/{resources => theme}/light.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/link.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/menu.svg (100%)
 rename cmd/tools/vdoc/{resources => theme}/normalize.css (100%)

diff --git a/cmd/tools/vcomplete.v b/cmd/tools/vcomplete.v
index cd4bb61c84..985a601643 100644
--- a/cmd/tools/vcomplete.v
+++ b/cmd/tools/vcomplete.v
@@ -203,6 +203,7 @@ const (
 		'-pos',
 		'-no-timestamp',
 		'-inline-assets',
+		'-theme-dir',
 		'-open',
 		'-p',
 		'-s',
diff --git a/cmd/tools/vdoc/html.v b/cmd/tools/vdoc/html.v
index aa5c90ec14..574e13b52a 100644
--- a/cmd/tools/vdoc/html.v
+++ b/cmd/tools/vdoc/html.v
@@ -13,69 +13,8 @@ import v.pref
 
 const (
 	css_js_assets = ['doc.css', 'normalize.css', 'doc.js', 'dark-mode.js']
-	res_path      = os.resource_abs_path('resources')
-	favicons_path = os.join_path(res_path, 'favicons')
+	default_theme = os.resource_abs_path('theme')
 	link_svg      = '<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/></svg>'
-	html_content  = '<!DOCTYPE html>
-<html lang="en">
-	<head>
-		<meta charset="UTF-8">
-		<meta http-equiv="x-ua-compatible" content="IE=edge" />
-		<meta name="viewport" content="width=device-width, initial-scale=1.0">
-		<title>{{ title }} | vdoc</title>
-		<link rel="preconnect" href="https://fonts.googleapis.com">
-		<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-		<link href="https://fonts.googleapis.com/css2?family=Jost:wght@300;400;500;600;700&display=swap" rel="stylesheet">
-		<link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono&display=swap" rel="stylesheet">
-		<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
-		<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
-		<link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
-		<link rel="manifest" href="site.webmanifest">
-		<link rel="mask-icon" href="safari-pinned-tab.svg" color="#5bbad5">
-		<meta name="msapplication-TileColor" content="#da532c">
-		<meta name="theme-color" content="#ffffff">
-		{{ head_assets }}
-	</head>
-	<body>
-		<div><a id="skip-to-content-link" href="#main-content">Skip to content</a></div>
-		<div id="page">
-			<header class="doc-nav hidden">
-				<div class="heading-container">
-					<div class="heading">
-						<div class="info">
-							<div class="module">{{ head_name }}</div>
-							<div class="toggle-version-container">
-								<span>{{ version }}</span>
-								<div id="dark-mode-toggle" role="switch" aria-checked="false" aria-label="Toggle dark mode">{{ light_icon }}{{ dark_icon }}</div>
-							</div>
-							{{ menu_icon }}
-						</div>
-						<input type="text" id="search" placeholder="Search... (beta)" autocomplete="off">
-					</div>
-				</div>
-				<nav class="search hidden"></nav>
-				<nav class="content hidden">
-					<ul>
-						{{ toc_links }}
-					</ul>
-				</nav>
-			</header>
-			<div class="doc-scrollview" id="main-content">
-				<div class="doc-container">
-					<div class="doc-content">
-{{ contents }}
-						<div class="footer">
-							{{ footer_content }}
-						</div>
-					</div>
-					{{ right_content }}
-				</div>
-			</div>
-		</div>
-		{{ footer_assets }}
-		<script async src="search_index.js" type="text/javascript"></script>
-	</body>
-</html>'
 )
 
 enum HighlightTokenTyp {
@@ -150,7 +89,7 @@ fn (mut vd VDoc) render_static_html(out Output) {
 
 fn (vd VDoc) get_resource(name string, out Output) string {
 	cfg := vd.cfg
-	path := os.join_path(res_path, name)
+	path := os.join_path(cfg.theme_dir, name)
 	mut res := os.read_file(path) or { panic('vdoc: could not read $path') }
 	/*
 	if minify {
@@ -301,8 +240,9 @@ fn (vd VDoc) gen_html(d doc.Doc) string {
 	}
 	modules_toc_str := modules_toc.str()
 	symbols_toc_str := symbols_toc.str()
-	result := html_content.replace('{{ title }}', d.head.name).replace('{{ head_name }}',
-		header_name).replace('{{ version }}', version).replace('{{ light_icon }}', vd.assets['light_icon']).replace('{{ dark_icon }}',
+	result := (os.read_file(os.join_path(cfg.theme_dir, 'index.html')) or { panic(err) }).replace('{{ title }}',
+		d.head.name).replace('{{ head_name }}', header_name).replace('{{ version }}',
+		version).replace('{{ light_icon }}', vd.assets['light_icon']).replace('{{ dark_icon }}',
 		vd.assets['dark_icon']).replace('{{ menu_icon }}', vd.assets['menu_icon']).replace('{{ head_assets }}',
 		if cfg.inline_assets {
 		'\n${tabs[0]}<style>' + vd.assets['doc_css'] + '</style>\n${tabs[0]}<style>' +
diff --git a/cmd/tools/vdoc/resources/arrow.svg b/cmd/tools/vdoc/theme/arrow.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/arrow.svg
rename to cmd/tools/vdoc/theme/arrow.svg
diff --git a/cmd/tools/vdoc/resources/dark-mode.js b/cmd/tools/vdoc/theme/dark-mode.js
similarity index 100%
rename from cmd/tools/vdoc/resources/dark-mode.js
rename to cmd/tools/vdoc/theme/dark-mode.js
diff --git a/cmd/tools/vdoc/resources/dark.svg b/cmd/tools/vdoc/theme/dark.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/dark.svg
rename to cmd/tools/vdoc/theme/dark.svg
diff --git a/cmd/tools/vdoc/resources/doc.css b/cmd/tools/vdoc/theme/doc.css
similarity index 100%
rename from cmd/tools/vdoc/resources/doc.css
rename to cmd/tools/vdoc/theme/doc.css
diff --git a/cmd/tools/vdoc/resources/doc.js b/cmd/tools/vdoc/theme/doc.js
similarity index 100%
rename from cmd/tools/vdoc/resources/doc.js
rename to cmd/tools/vdoc/theme/doc.js
diff --git a/cmd/tools/vdoc/resources/favicons/android-chrome-192x192.png b/cmd/tools/vdoc/theme/favicons/android-chrome-192x192.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/android-chrome-192x192.png
rename to cmd/tools/vdoc/theme/favicons/android-chrome-192x192.png
diff --git a/cmd/tools/vdoc/resources/favicons/android-chrome-512x512.png b/cmd/tools/vdoc/theme/favicons/android-chrome-512x512.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/android-chrome-512x512.png
rename to cmd/tools/vdoc/theme/favicons/android-chrome-512x512.png
diff --git a/cmd/tools/vdoc/resources/favicons/apple-touch-icon.png b/cmd/tools/vdoc/theme/favicons/apple-touch-icon.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/apple-touch-icon.png
rename to cmd/tools/vdoc/theme/favicons/apple-touch-icon.png
diff --git a/cmd/tools/vdoc/resources/favicons/browserconfig.xml b/cmd/tools/vdoc/theme/favicons/browserconfig.xml
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/browserconfig.xml
rename to cmd/tools/vdoc/theme/favicons/browserconfig.xml
diff --git a/cmd/tools/vdoc/resources/favicons/favicon-16x16.png b/cmd/tools/vdoc/theme/favicons/favicon-16x16.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/favicon-16x16.png
rename to cmd/tools/vdoc/theme/favicons/favicon-16x16.png
diff --git a/cmd/tools/vdoc/resources/favicons/favicon-32x32.png b/cmd/tools/vdoc/theme/favicons/favicon-32x32.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/favicon-32x32.png
rename to cmd/tools/vdoc/theme/favicons/favicon-32x32.png
diff --git a/cmd/tools/vdoc/resources/favicons/favicon.ico b/cmd/tools/vdoc/theme/favicons/favicon.ico
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/favicon.ico
rename to cmd/tools/vdoc/theme/favicons/favicon.ico
diff --git a/cmd/tools/vdoc/resources/favicons/mstile-144x144.png b/cmd/tools/vdoc/theme/favicons/mstile-144x144.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/mstile-144x144.png
rename to cmd/tools/vdoc/theme/favicons/mstile-144x144.png
diff --git a/cmd/tools/vdoc/resources/favicons/mstile-150x150.png b/cmd/tools/vdoc/theme/favicons/mstile-150x150.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/mstile-150x150.png
rename to cmd/tools/vdoc/theme/favicons/mstile-150x150.png
diff --git a/cmd/tools/vdoc/resources/favicons/mstile-310x150.png b/cmd/tools/vdoc/theme/favicons/mstile-310x150.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/mstile-310x150.png
rename to cmd/tools/vdoc/theme/favicons/mstile-310x150.png
diff --git a/cmd/tools/vdoc/resources/favicons/mstile-310x310.png b/cmd/tools/vdoc/theme/favicons/mstile-310x310.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/mstile-310x310.png
rename to cmd/tools/vdoc/theme/favicons/mstile-310x310.png
diff --git a/cmd/tools/vdoc/resources/favicons/mstile-70x70.png b/cmd/tools/vdoc/theme/favicons/mstile-70x70.png
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/mstile-70x70.png
rename to cmd/tools/vdoc/theme/favicons/mstile-70x70.png
diff --git a/cmd/tools/vdoc/resources/favicons/safari-pinned-tab.svg b/cmd/tools/vdoc/theme/favicons/safari-pinned-tab.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/safari-pinned-tab.svg
rename to cmd/tools/vdoc/theme/favicons/safari-pinned-tab.svg
diff --git a/cmd/tools/vdoc/resources/favicons/site.webmanifest b/cmd/tools/vdoc/theme/favicons/site.webmanifest
similarity index 100%
rename from cmd/tools/vdoc/resources/favicons/site.webmanifest
rename to cmd/tools/vdoc/theme/favicons/site.webmanifest
diff --git a/cmd/tools/vdoc/theme/index.html b/cmd/tools/vdoc/theme/index.html
new file mode 100644
index 0000000000..8c7dd75482
--- /dev/null
+++ b/cmd/tools/vdoc/theme/index.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="x-ua-compatible" content="IE=edge" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>{{ title }} | vdoc</title>
+  <link rel="preconnect" href="https://fonts.googleapis.com">
+  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+  <link href="https://fonts.googleapis.com/css2?family=Jost:wght@300;400;500;600;700&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono&display=swap" rel="stylesheet">
+  <link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
+  <link rel="manifest" href="site.webmanifest">
+  <link rel="mask-icon" href="safari-pinned-tab.svg" color="#5bbad5">
+  <meta name="msapplication-TileColor" content="#da532c">
+  <meta name="theme-color" content="#ffffff">
+  {{ head_assets }}
+</head>
+
+<body>
+  <div><a id="skip-to-content-link" href="#main-content">Skip to content</a></div>
+  <div id="page">
+    <header class="doc-nav hidden">
+      <div class="heading-container">
+        <div class="heading">
+          <div class="info">
+            <div class="module">{{ head_name }}</div>
+            <div class="toggle-version-container">
+              <span>{{ version }}</span>
+              <div id="dark-mode-toggle" role="switch" aria-checked="false" aria-label="Toggle dark mode">{{ light_icon }}{{ dark_icon }}</div>
+            </div>
+            {{ menu_icon }}
+          </div>
+          <input type="text" id="search" placeholder="Search... (beta)" autocomplete="off">
+        </div>
+      </div>
+      <nav class="search hidden"></nav>
+      <nav class="content hidden">
+        <ul>
+          {{ toc_links }}
+        </ul>
+      </nav>
+    </header>
+    <div class="doc-scrollview" id="main-content">
+      <div class="doc-container">
+        <div class="doc-content">
+          {{ contents }}
+          <div class="footer">
+            {{ footer_content }}
+          </div>
+        </div>
+        {{ right_content }}
+      </div>
+    </div>
+  </div>
+  {{ footer_assets }}
+  <script async src="search_index.js"></script>
+</body>
+
+</html>
diff --git a/cmd/tools/vdoc/resources/light.svg b/cmd/tools/vdoc/theme/light.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/light.svg
rename to cmd/tools/vdoc/theme/light.svg
diff --git a/cmd/tools/vdoc/resources/link.svg b/cmd/tools/vdoc/theme/link.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/link.svg
rename to cmd/tools/vdoc/theme/link.svg
diff --git a/cmd/tools/vdoc/resources/menu.svg b/cmd/tools/vdoc/theme/menu.svg
similarity index 100%
rename from cmd/tools/vdoc/resources/menu.svg
rename to cmd/tools/vdoc/theme/menu.svg
diff --git a/cmd/tools/vdoc/resources/normalize.css b/cmd/tools/vdoc/theme/normalize.css
similarity index 100%
rename from cmd/tools/vdoc/resources/normalize.css
rename to cmd/tools/vdoc/theme/normalize.css
diff --git a/cmd/tools/vdoc/vdoc.v b/cmd/tools/vdoc/vdoc.v
index aaa85243c1..728a1d63da 100644
--- a/cmd/tools/vdoc/vdoc.v
+++ b/cmd/tools/vdoc/vdoc.v
@@ -53,6 +53,7 @@ mut:
 	include_examples bool = true
 	include_comments bool // for plaintext
 	inline_assets    bool
+	theme_dir        string = default_theme
 	no_timestamp     bool
 	output_path      string
 	output_type      OutputType = .unset
@@ -378,6 +379,9 @@ fn (mut vd VDoc) generate_docs_from_file() {
 			vd.render_search_index(out)
 			// move favicons to target directory
 			println('Copying favicons...')
+
+			favicons_path := os.join_path(cfg.theme_dir, 'favicons')
+
 			favicons := os.ls(favicons_path) or { panic(err) }
 			for favicon in favicons {
 				favicon_path := os.join_path(favicons_path, favicon)
@@ -423,6 +427,9 @@ fn parse_arguments(args []string) Config {
 			'-inline-assets' {
 				cfg.inline_assets = true
 			}
+			'-theme-dir' {
+				cfg.theme_dir = cmdline.option(current_args, '-theme-dir', default_theme)
+			}
 			'-l' {
 				cfg.show_loc = true
 			}
diff --git a/cmd/v/help/doc.txt b/cmd/v/help/doc.txt
index afbc3968fd..a1bd8d1fb4 100644
--- a/cmd/v/help/doc.txt
+++ b/cmd/v/help/doc.txt
@@ -29,6 +29,7 @@ Options:
 
 For HTML mode:
   -inline-assets  Embeds the contents of the CSS and JS assets into the webpage directly.
+  -theme-dir      The directory for doc theme template
 
 For plain text mode:
   -l              Shows the locations of the generated signatures.