tools: add a `-theme-dir folder/` parameter to `v doc` (#13550)
gcxfd
GitHub
|
|
@ -203,6 +203,7 @@ const (
|
||||||
'-pos',
|
'-pos',
|
||||||
'-no-timestamp',
|
'-no-timestamp',
|
||||||
'-inline-assets',
|
'-inline-assets',
|
||||||
|
'-theme-dir',
|
||||||
'-open',
|
'-open',
|
||||||
'-p',
|
'-p',
|
||||||
'-s',
|
'-s',
|
||||||
|
|
|
||||||
|
|
@ -13,69 +13,8 @@ import v.pref
|
||||||
|
|
||||||
const (
|
const (
|
||||||
css_js_assets = ['doc.css', 'normalize.css', 'doc.js', 'dark-mode.js']
|
css_js_assets = ['doc.css', 'normalize.css', 'doc.js', 'dark-mode.js']
|
||||||
res_path = os.resource_abs_path('resources')
|
default_theme = os.resource_abs_path('theme')
|
||||||
favicons_path = os.join_path(res_path, 'favicons')
|
|
||||||
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>'
|
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 {
|
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 {
|
fn (vd VDoc) get_resource(name string, out Output) string {
|
||||||
cfg := vd.cfg
|
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') }
|
mut res := os.read_file(path) or { panic('vdoc: could not read $path') }
|
||||||
/*
|
/*
|
||||||
if minify {
|
if minify {
|
||||||
|
|
@ -301,8 +240,9 @@ fn (vd VDoc) gen_html(d doc.Doc) string {
|
||||||
}
|
}
|
||||||
modules_toc_str := modules_toc.str()
|
modules_toc_str := modules_toc.str()
|
||||||
symbols_toc_str := symbols_toc.str()
|
symbols_toc_str := symbols_toc.str()
|
||||||
result := html_content.replace('{{ title }}', d.head.name).replace('{{ head_name }}',
|
result := (os.read_file(os.join_path(cfg.theme_dir, 'index.html')) or { panic(err) }).replace('{{ title }}',
|
||||||
header_name).replace('{{ version }}', version).replace('{{ light_icon }}', vd.assets['light_icon']).replace('{{ dark_icon }}',
|
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 }}',
|
vd.assets['dark_icon']).replace('{{ menu_icon }}', vd.assets['menu_icon']).replace('{{ head_assets }}',
|
||||||
if cfg.inline_assets {
|
if cfg.inline_assets {
|
||||||
'\n${tabs[0]}<style>' + vd.assets['doc_css'] + '</style>\n${tabs[0]}<style>' +
|
'\n${tabs[0]}<style>' + vd.assets['doc_css'] + '</style>\n${tabs[0]}<style>' +
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 175 B After Width: | Height: | Size: 175 B |
|
Before Width: | Height: | Size: 642 B After Width: | Height: | Size: 642 B |
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 5.9 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 5.6 KiB After Width: | Height: | Size: 5.6 KiB |
|
Before Width: | Height: | Size: 853 B After Width: | Height: | Size: 853 B |
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
|
|
@ -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>
|
||||||
|
Before Width: | Height: | Size: 499 B After Width: | Height: | Size: 499 B |
|
Before Width: | Height: | Size: 350 B After Width: | Height: | Size: 350 B |
|
Before Width: | Height: | Size: 201 B After Width: | Height: | Size: 201 B |
|
|
@ -53,6 +53,7 @@ mut:
|
||||||
include_examples bool = true
|
include_examples bool = true
|
||||||
include_comments bool // for plaintext
|
include_comments bool // for plaintext
|
||||||
inline_assets bool
|
inline_assets bool
|
||||||
|
theme_dir string = default_theme
|
||||||
no_timestamp bool
|
no_timestamp bool
|
||||||
output_path string
|
output_path string
|
||||||
output_type OutputType = .unset
|
output_type OutputType = .unset
|
||||||
|
|
@ -378,6 +379,9 @@ fn (mut vd VDoc) generate_docs_from_file() {
|
||||||
vd.render_search_index(out)
|
vd.render_search_index(out)
|
||||||
// move favicons to target directory
|
// move favicons to target directory
|
||||||
println('Copying favicons...')
|
println('Copying favicons...')
|
||||||
|
|
||||||
|
favicons_path := os.join_path(cfg.theme_dir, 'favicons')
|
||||||
|
|
||||||
favicons := os.ls(favicons_path) or { panic(err) }
|
favicons := os.ls(favicons_path) or { panic(err) }
|
||||||
for favicon in favicons {
|
for favicon in favicons {
|
||||||
favicon_path := os.join_path(favicons_path, favicon)
|
favicon_path := os.join_path(favicons_path, favicon)
|
||||||
|
|
@ -423,6 +427,9 @@ fn parse_arguments(args []string) Config {
|
||||||
'-inline-assets' {
|
'-inline-assets' {
|
||||||
cfg.inline_assets = true
|
cfg.inline_assets = true
|
||||||
}
|
}
|
||||||
|
'-theme-dir' {
|
||||||
|
cfg.theme_dir = cmdline.option(current_args, '-theme-dir', default_theme)
|
||||||
|
}
|
||||||
'-l' {
|
'-l' {
|
||||||
cfg.show_loc = true
|
cfg.show_loc = true
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -29,6 +29,7 @@ Options:
|
||||||
|
|
||||||
For HTML mode:
|
For HTML mode:
|
||||||
-inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.
|
-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:
|
For plain text mode:
|
||||||
-l Shows the locations of the generated signatures.
|
-l Shows the locations of the generated signatures.
|
||||||
|
|
|
||||||