diff --git a/.gitignore b/.gitignore
index 534b0b840..aac1325cf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,6 +15,7 @@ bin/
.DS_Store
.idea/
.vscode/
+.nova/
*.iml
# ENV
diff --git a/README.md b/README.md
index 5a193807b..1b52133fa 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,10 @@ original V [docs.md](https://github.com/vlang/v/blob/master/doc/docs.md)
## External dependencies
-You'll need V, of course. Best to
+This project only requires V. Best to
[install it from source](https://github.com/vlang/v?tab=readme-ov-file#installing-v-from-source)
if you don't already have it.
-Make sure you have [sass](https://sass-lang.com/install/) installed
-locally to build the css files.
-
## Contributing
To setup the generator and contribute changes to it, do this once:
@@ -31,14 +28,20 @@ To build the documentation, after the setup, run the following commands:
```shell
v run .
```
-This will download the latest version
+This will download the latest version
of [docs.md](https://github.com/vlang/v/edit/master/doc/docs.md),
then it will regenerate the documentation from it, and save it in the `output`
directory.
## Testing the output
+
+Use V to serve your local copy of the documentation.
+
```shell
v -e 'import net.http.file; file.serve(folder: "output/")'
```
-Now load http://localhost:4001/ in your browser.
+
+The line of code executed will start a basic web server with the documentation created in the "outputs" folder.
+
+Access the documentation on your browser using this url http://localhost:4001/.
diff --git a/main.v b/main.v
index 2642ad8d5..84251796f 100644
--- a/main.v
+++ b/main.v
@@ -20,7 +20,8 @@ fn main() {
commit_res := os.execute_or_exit('git ls-remote -h https://github.com/vlang/v.git refs/heads/master')
latest_v_commit_hash := commit_res.output.all_before('\t')
- update_sass()
+ //Removed need for sass, using css variables
+ //update_sass()
mut ctx := Context{
full_text: response.body
@@ -39,11 +40,18 @@ mut:
}
fn (mut ctx Context) write_mapping() ! {
- content := '
-const titles_to_fnames = ${json.encode_pretty(ctx.titles_to_fnames)};
-const fnames = ${json.encode_pretty(ctx.pages)};
-'
- write_output_file('assets/scripts/titles_to_fnames.js', content)!
+ js_file_index := '
+ // Lookups of sections to files
+ vdocs.titles_to_fnames = ${json.encode_pretty(ctx.titles_to_fnames)};
+ vdocs.fnames = ${json.encode_pretty(ctx.pages)};'
+
+ js_src := os.read_file('templates/assets/scripts/v-docs.js') or {
+ eprintln('Failed to read file: $err')
+ return
+ }
+
+ write_output_file('assets/scripts/v-docs.js', js_src + js_file_index)!
+
eprintln('> Total titles: ${ctx.titles_to_fnames.len}')
eprintln('> HTML pages: ${ctx.pages.len}')
}
diff --git a/sass.v b/sass.v
deleted file mode 100644
index 0d979938e..000000000
--- a/sass.v
+++ /dev/null
@@ -1,22 +0,0 @@
-module main
-
-import os
-
-fn update_sass() {
- // Note: sass is https://sass-lang.com/dart-sass/, while sassc is https://github.com/sass/sassc .
- // On the FreeBSD vps, where the documentation is generated, *only `sassc` is available* natively,
- // and the `sass` tool, does not have an easily installable prebuilt native version for FreeBSD,
- // only a slower transpiled to JS version, installed through `npm install -g sass`.
- //
- // In comparison, they both produce nearly equal output with --style=expanded , except for:
- // a) `transition: fill 0.25s;` vs `transition: fill .25s;`
- // b) some newlines at the end of each CSS rule
- // c) style.css.map is different.
- sass_cmd := 'sassc --sourcemap=auto --style=expanded templates/assets/styles/style.scss templates/assets/styles/style.css'
- // sass_cmd := 'sass --style=expanded templates/assets/styles/style.scss templates/assets/styles/style.css'
- res := os.system(sass_cmd)
- if res != 0 {
- eprintln('sass compilation failed, cmd: `${sass_cmd}`')
- exit(1)
- }
-}
diff --git a/templates/assets/scripts/cm-lang-v.js b/templates/assets/scripts/cm-lang-v.js
new file mode 100644
index 000000000..ee6e402df
--- /dev/null
+++ b/templates/assets/scripts/cm-lang-v.js
@@ -0,0 +1,617 @@
+
+/*
+ V-Lang Language Mode for CodeMirror
+*/
+(function(mod) {
+ if (typeof exports == "object" && typeof module == "object") // CommonJS
+ mod(require("../../lib/codemirror"));
+ else if (typeof define == "function" && define.amd) // AMD
+ define(["../../lib/codemirror"], mod);
+ else // Plain browser env
+ mod(CodeMirror);
+})(function(CodeMirror) {
+
+const baseAttributes = [
+ "params", "noinit", "required", "skip", "assert_continues",
+ "unsafe", "manualfree", "heap", "nonnull", "primary", "inline",
+ "direct_array_access", "live", "flag", "noinline", "noreturn", "typedef", "console",
+ "sql", "table", "deprecated", "deprecated_after", "export", "callconv"
+];
+const baseModules = [
+ "arrays",
+ "benchmark", "bitfield",
+ "cli", "clipboard", "compress", "context", "crypto",
+ "darwin", "datatypes", "dl", "dlmalloc",
+ "encoding", "eventbus",
+ "flag", "fontstash",
+ "gg", "gx",
+ "hash",
+ "io",
+ "js", "json",
+ "log",
+ "math", "mssql", "mysql",
+ "net",
+ "orm", "os",
+ "pg", "picoev", "picohttpparser",
+ "rand", "readline", "regex", "runtime",
+ "semver", "sokol", "sqlite", "stbi", "strconv", "strings", "sync", "szip",
+ "term", "time", "toml",
+ "v", "vweb",
+ "x",
+];
+const word = "[\\w_]+";
+//[key: value]
+const keyValue = `(${word}: ${word})`;
+
+// [if expr ?]
+const ifAttributesRegexp = new RegExp(`^if ${word} \\??]`);
+// [key: value; key: value]
+const keyValueAttributesRegexp = new RegExp(`^((${keyValue})(; )?){2,}]$`);
+const simpleAttributesRegexp = new RegExp(`^(${baseAttributes.join("|")})]$`);
+const singleKeyValueAttributesRegexp = new RegExp(`^${keyValue}]$`);
+const severalSingleKeyValueAttributesRegexp = new RegExp(`^(${baseAttributes.join("|")}(; ?)?){2,}]$`);
+
+class Context {
+ constructor(
+ indentation,
+ column,
+ type,
+ align,
+ prev,
+ knownImports = new Set()
+ ) {
+ this.indentation = indentation
+ this.column = column
+ this.type = type
+ this.align = align
+ this.prev = prev
+ this.knownImports = knownImports
+ }
+
+ /**
+ * Whenever current position inside a string.
+ */
+ insideString = false
+
+ /**
+ * Current quotation mark.
+ * Valid only when insideString is true.
+ */
+ stringQuote = null
+
+ /**
+ * Whenever next token expected to be an import name.
+ * Used for highlighting import names in import statements.
+ */
+ expectedImportName = false
+}
+
+const keywords = new Set([
+ "as",
+ "asm",
+ "assert",
+ "atomic",
+ "break",
+ "const",
+ "continue",
+ "defer",
+ "else",
+ "enum",
+ "fn",
+ "for",
+ "go",
+ "goto",
+ "if",
+ "implements",
+ "import",
+ "in",
+ "interface",
+ "is",
+ "isreftype",
+ "lock",
+ "match",
+ "module",
+ "mut",
+ "none",
+ "or",
+ "pub",
+ "return",
+ "rlock",
+ "select",
+ "shared",
+ "sizeof",
+ "static",
+ "struct",
+ "spawn",
+ "type",
+ "typeof",
+ "union",
+ "unsafe",
+ "volatile",
+ "__global",
+ "__offsetof"
+])
+
+const pseudoKeywords = new Set(["sql", "chan", "thread"])
+
+const hashDirectives = new Set(["#flag", "#include", "#pkgconfig"])
+
+const atoms = new Set([
+ "true",
+ "false",
+ "nil",
+ "print",
+ "println",
+ "exit",
+ "panic",
+ "error",
+ "dump"
+])
+
+const builtinTypes = new Set([
+ "bool",
+ "string",
+ "i8",
+ "i16",
+ "int",
+ "i32",
+ "i64",
+ "i128",
+ "u8",
+ "u16",
+ "u32",
+ "u64",
+ "u128",
+ "rune",
+ "f32",
+ "f64",
+ "isize",
+ "usize",
+ "voidptr",
+ "any"
+])
+
+
+CodeMirror.defineMode("v", config => {
+ const indentUnit = config.indentUnit ?? 0
+
+ const isOperatorChar = /[+\-*&^%:=<>!?|\/]/
+
+ let curPunc = null
+
+ function eatIdentifier(stream) {
+ stream.eatWhile(/[\w$_\xa1-\uffff]/)
+ return stream.current()
+ }
+
+ function tokenBase(stream, state) {
+ const ch = stream.next()
+ if (ch === null) {
+ return null
+ }
+
+ if (state.context.insideString && ch === "}") {
+ stream.eat("}")
+ state.tokenize = tokenString(state.context.stringQuote)
+ return "end-interpolation"
+ }
+
+ if (ch === '"' || ch === "'" || ch === "`") {
+ state.tokenize = tokenString(ch)
+ return state.tokenize(stream, state)
+ }
+
+ // r'foo' or c'foo'
+ // r"foo" or c"foo"
+ if (
+ (ch === "r" || ch === "c") &&
+ (stream.peek() == '"' || stream.peek() == "'")
+ ) {
+ const next = stream.next()
+ if (next === null) {
+ return "string"
+ }
+ state.tokenize = tokenRawString(next)
+ return "string"
+ }
+
+ if (ch === ".") {
+ if (!stream.match(/^[0-9]+([eE][\-+]?[0-9]+)?/)) {
+ return "operator"
+ }
+ }
+
+ // probably attribute
+ // [attr]
+ // [attr: value]
+ // [attr1; attr2]
+ if (ch === "[") {
+ // [unsafe]
+ if (stream.match(simpleAttributesRegexp)) {
+ return "attribute"
+ }
+
+ // [sql: foo]
+ if (stream.match(singleKeyValueAttributesRegexp)) {
+ return "attribute"
+ }
+
+ // [sql; foo]
+ if (stream.match(severalSingleKeyValueAttributesRegexp)) {
+ return "attribute"
+ }
+
+ // [attr: value; attr: value]
+ // [attr: value; attr]
+ if (stream.match(keyValueAttributesRegexp)) {
+ return "attribute"
+ }
+
+ // match `[if some ?]`
+ if (stream.match(ifAttributesRegexp)) {
+ return "attribute"
+ }
+ }
+
+ if (/[\d.]/.test(ch)) {
+ if (ch === "0") {
+ stream.match(/^[xX][0-9a-fA-F_]+/) ||
+ stream.match(/^o[0-7_]+/) ||
+ stream.match(/^b[0-1_]+/)
+ } else {
+ stream.match(/^[0-9_]*\.?[0-9_]*([eE][\-+]?[0-9_]+)?/)
+ }
+ return "number"
+ }
+ if (/[\[\]{}(),;:.]/.test(ch)) {
+ curPunc = ch
+ return null
+ }
+ if (ch === "/") {
+ if (stream.eat("*")) {
+ state.tokenize = tokenComment
+ return tokenComment(stream, state)
+ }
+ if (stream.eat("/")) {
+ stream.skipToEnd()
+ return "comment"
+ }
+ }
+ if (isOperatorChar.test(ch)) {
+ stream.eatWhile(isOperatorChar)
+ return "operator"
+ }
+
+ if (ch === "@") {
+ eatIdentifier(stream)
+ return "at-identifier"
+ }
+
+ if (ch === "$") {
+ const ident = eatIdentifier(stream).slice(1)
+ if (keywords.has(ident)) {
+ return "keyword"
+ }
+
+ return "compile-time-identifier"
+ }
+
+ stream.backUp(2)
+ const wasDot = stream.next() === "."
+ stream.next()
+
+ const cur = eatIdentifier(stream)
+ if (cur === "import") {
+ state.context.expectedImportName = true
+ }
+
+ if (keywords.has(cur)) return "keyword"
+ if (pseudoKeywords.has(cur)) return "keyword"
+ if (atoms.has(cur)) return "atom"
+ if (hashDirectives.has(cur)) return "hash-directive"
+
+ if (!wasDot) {
+ // don't highlight `foo.int()`
+ // ^^^ as builtin
+ if (builtinTypes.has(cur)) return "builtin"
+ }
+
+ if (cur.length > 0 && cur[0].toUpperCase() === cur[0]) {
+ return "type"
+ }
+
+ const next = stream.peek()
+ if (next === "(" || next === "<") {
+ return "function"
+ }
+
+ if (next === "[") {
+ stream.next()
+ const after = stream.next()
+ stream.backUp(2)
+ if (after != null && after.match(/[A-Z]/i)) {
+ return "function"
+ }
+ }
+
+ // highlight only last part
+ // example:
+ // import foo.boo
+ // ^^^ - only this part will be highlighted
+ if (state.context.expectedImportName && stream.peek() !== ".") {
+ state.context.expectedImportName = false
+ if (state.context.knownImports === undefined) {
+ state.context.knownImports = new Set()
+ }
+ state.context.knownImports.add(cur)
+ return "import-name"
+ }
+
+ if (wasDot) {
+ return "property"
+ }
+
+ // highlight only identifier with dot after it
+ // example:
+ // import foo
+ // import bar
+ //
+ // foo.bar
+ // ^^^ - only this part will be highlighted
+ if (state.context.knownImports.has(cur) && stream.peek() == ".") {
+ return "import-name"
+ }
+
+ return "variable"
+ }
+
+ function tokenLongInterpolation(stream, state) {
+ if (stream.match("}")) {
+ state.tokenize = tokenString(state.context.stringQuote)
+ return "end-interpolation"
+ }
+ state.tokenize = tokenBase
+ return state.tokenize(stream, state)
+ }
+
+ function tokenShortInterpolation(stream, state) {
+ const ch = stream.next()
+ if (ch === " ") {
+ state.tokenize = tokenString(state.context.stringQuote)
+ return state.tokenize(stream, state)
+ }
+ if (ch === ".") {
+ return "operator"
+ }
+
+ const ident = eatIdentifier(stream)
+ if (ident[0].toLowerCase() === ident[0].toUpperCase()) {
+ state.tokenize = tokenString(state.context.stringQuote)
+ return state.tokenize(stream, state)
+ }
+
+ const next = stream.next()
+ stream.backUp(1)
+ if (next === ".") {
+ state.tokenize = tokenShortInterpolation
+ } else {
+ state.tokenize = tokenString(state.context.stringQuote)
+ }
+
+ return "variable"
+ }
+
+ function tokenNextInterpolation(stream, state) {
+ let next = stream.next()
+ if (next === "$" && stream.eat("{")) {
+ state.tokenize = tokenLongInterpolation
+ return "start-interpolation"
+ }
+ if (next === "$") {
+ state.tokenize = tokenShortInterpolation
+ return "start-interpolation"
+ }
+
+ return "string"
+ }
+
+ function tokenNextEscape(stream, state) {
+ let next = stream.next()
+ if (next === "\\") {
+ stream.next()
+ state.tokenize = tokenString(state.context.stringQuote)
+ // we already know that next char is valid escape
+ return "valid-escape"
+ }
+
+ return "string"
+ }
+
+ function isValidEscapeChar(ch) {
+ return (
+ ch === "n" ||
+ ch === "t" ||
+ ch === "r" ||
+ ch === "\\" ||
+ ch === '"' ||
+ ch === "'" ||
+ ch === "0"
+ )
+ }
+
+ function tokenString(quote) {
+ return function(stream, state) {
+ state.context.insideString = true
+ state.context.stringQuote = quote
+
+ let next = ""
+ let escaped = false
+ let end = false
+
+ while ((next = stream.next()) != null) {
+ if (next === quote && !escaped) {
+ end = true
+ break
+ }
+ if (next === "$" && !escaped && stream.eat("{")) {
+ state.tokenize = tokenNextInterpolation
+ stream.backUp(2)
+ return "string"
+ }
+ if (next === "$" && !escaped) {
+ state.tokenize = tokenNextInterpolation
+ stream.backUp(1)
+ return "string"
+ }
+ if (escaped && isValidEscapeChar(next)) {
+ stream.backUp(2)
+ state.tokenize = tokenNextEscape
+ return "string"
+ }
+ escaped = !escaped && next === "\\"
+ }
+
+ if (end || escaped) {
+ state.tokenize = tokenBase
+ }
+
+ state.context.insideString = false
+ state.context.stringQuote = null
+ return "string"
+ }
+ }
+
+ function tokenRawString(quote) {
+ return function(stream, state) {
+ state.context.insideString = true
+ state.context.stringQuote = quote
+
+ let next = ""
+ let escaped = false
+ let end = false
+
+ while ((next = stream.next()) != null) {
+ if (next === quote && !escaped) {
+ end = true
+ break
+ }
+ escaped = !escaped && next === "\\"
+ }
+
+ if (end || escaped) {
+ state.tokenize = tokenBase
+ }
+
+ state.context.insideString = false
+ state.context.stringQuote = null
+ return "string"
+ }
+ }
+
+ function tokenComment(stream, state) {
+ let maybeEnd = false
+ let ch
+ while ((ch = stream.next())) {
+ if (ch === "/" && maybeEnd) {
+ state.tokenize = tokenBase
+ break
+ }
+ maybeEnd = ch === "*"
+ }
+ return "comment"
+ }
+
+ function pushContext(state, column, type) {
+ return (state.context = new Context(
+ state.indention,
+ column,
+ type,
+ null,
+ state.context,
+ state.context.knownImports
+ ))
+ }
+
+ function popContext(state) {
+ if (!state.context.prev) return
+ const t = state.context.type
+ if (t === ")" || t === "]" || t === "}")
+ state.indention = state.context.indentation
+ state.context = state.context.prev
+ return state.context
+ }
+
+ return {
+ startState: function() {
+ return {
+ tokenize: null,
+ context: new Context(0, 0, "top", false),
+ indention: 0,
+ startOfLine: true
+ }
+ },
+
+ token: function(stream, state) {
+ const ctx = state.context
+ if (stream.sol()) {
+ if (ctx.align == null) {
+ ctx.align = false
+ }
+ state.indention = stream.indentation()
+ state.startOfLine = true
+ }
+ if (stream.eatSpace()) {
+ return null
+ }
+ curPunc = null
+ const style = state.tokenize || tokenBase(stream, state)
+ if (style === "comment") {
+ return style
+ }
+ if (ctx.align == null) {
+ ctx.align = true
+ }
+
+ if (curPunc === "{") pushContext(state, stream.column(), "}")
+ else if (curPunc === "[") pushContext(state, stream.column(), "]")
+ else if (curPunc === "(") pushContext(state, stream.column(), ")")
+ else if (curPunc === "}" && ctx.type === "}") popContext(state)
+ else if (curPunc === ctx.type) popContext(state)
+ state.startOfLine = false
+ return style
+ },
+
+ indent: function(state, textAfter) {
+ if (state.tokenize !== tokenBase && state.tokenize != null) {
+ return 0
+ }
+
+ if (state.context.type == "top") {
+ return 0
+ }
+
+ const ctx = state.context
+ const firstChar = textAfter.charAt(0)
+
+ const closing = firstChar === ctx.type
+ if (ctx.align) {
+ return ctx.column + (closing ? 0 : 1)
+ }
+
+ return ctx.indentation + (closing ? 0 : indentUnit)
+ },
+
+ // @ts-ignore
+ electricChars: "{}):",
+ // @ts-ignore
+ closeBrackets: "()[]{}''\"\"``",
+ fold: "brace",
+ blockCommentStart: "/*",
+ blockCommentEnd: "*/",
+ lineComment: "//"
+ }
+})
+
+CodeMirror.defineMIME("text/x-v", "v");
+
+});
diff --git a/templates/assets/scripts/search.js b/templates/assets/scripts/search.js
deleted file mode 100644
index ef0d1ecb9..000000000
--- a/templates/assets/scripts/search.js
+++ /dev/null
@@ -1,145 +0,0 @@
-const original_docs_md_url = 'https://github.com/vlang/v/blob/master/doc/docs.md';
-const search_source_url = 'https://docs.vlang.io/assets/docs.md';
-let file_content = null;
-
-// Function to fetch and cache the file content
-async function fetchFileContent() {
- try {
- const response = await fetch(search_source_url);
- if (!response.ok) {
- throw new Error('Network response was not ok ' + response.statusText);
- }
- file_content = await response.text();
- } catch (error) {
- console.error('Failed to fetch file content:', error);
- }
-}
-
-// Function to parse the markdown content and create a map of sections
-function parseMarkdown(content) {
- const lines = content.split('\n');
- const sections = {};
- let currentSection = '';
-
- lines.forEach(line => {
- const sectionMatch = line.match(/^##+\s+(.+)/); // Match headers (##, ###, etc.)
- if (sectionMatch) {
- currentSection = sectionMatch[1];
- sections[currentSection] = [];
- } else if (currentSection) {
- sections[currentSection].push(line);
- }
- });
-
- return sections;
-}
-
-// Function to search through the cached file content and map results to sections
-function searchFileContent(query) {
- if (!file_content) {
- return 'File content not loaded. Please try again later.';
- }
-
- const sections = parseMarkdown(file_content);
- const results = [];
- const regex = new RegExp(query, 'gi');
-
- for (const section in sections) {
- const sectionContent = sections[section].join('\n');
- const match = sectionContent.match(regex);
- if (match) {
- results.push({ section, snippet: getSnippet(sectionContent, match[0]) });
- }
- }
-
- // Filter out the "Table of Contents" section
- return results.filter(result => result.section.toLowerCase() !== 'table of contents');
-}
-
-// Function to get a snippet of text around the first match
-function getSnippet(content, match) {
- const index = content.indexOf(match);
- const snippetLength = 100;
- const start = Math.max(index - snippetLength / 2, 0);
- const end = Math.min(index + snippetLength / 2, content.length);
- return content.substring(start, end).replace(/\n/g, ' ') + '...';
-}
-
-// Function to create links to the relevant sections in the docs
-function createResultLinks(results) {
- if (typeof results === 'string') {
- return results;
- }
-
- return results.map(result => {
- const sectionLink = sectionToLink(result.section);
- return `
-
- `;
- }).join('');
-}
-
-// Helper function to convert section titles to links
-function sectionToLink(section) {
- const fixed_url = titles_to_fnames[ section ];
- if (fixed_url) { return fixed_url; }
- const existing_html_page = fnames[ section ];
- if (existing_html_page) { return existing_html_page; }
- // try with a simpler normalized version of the section title:
- const slug = section.toLowerCase().replace(/\s+/g, '-').replace(/[^\w-]+/g, '')
- const sfixed_url = titles_to_fnames[ slug ];
- if (sfixed_url) { return sfixed_url; }
- const sexisting_html_page = fnames[ slug ];
- if (sexisting_html_page) { return sexisting_html_page; }
- // probably a 3rd level or lower title, that currently has no reverse mapping; redirect to the main docs.md:
- return `${original_docs_md_url}#${slug}`;
-}
-
-function display_search_results(how) {
- document.getElementById('searchResults').style.display = how;
-}
-
-async function handleSearch() {
- const query = document.getElementById('searchInput').value;
- const resultsElement = document.getElementById('searchResults');
- if (!file_content) {
- await fetchFileContent();
- }
- const results = searchFileContent(query);
- resultsElement.innerHTML = createResultLinks(results);
- display_search_results("block");
-}
-
-// Initialize the search functionality when the DOM is fully loaded
-document.addEventListener('DOMContentLoaded', () => {
- const searchInput = document.getElementById('searchInput');
- const searchKeys = document.getElementById('searchKeys');
- searchKeys.innerHTML = (navigator.platform.includes('Mac') ? '⌘' : 'Ctrl') + ' K';
- document.addEventListener('keydown', (event) => {
- if ((event.ctrlKey || event.metaKey) && event.key === 'k') {
- event.preventDefault();
- searchInput.focus();
- }
- });
- searchInput.onfocus = () => searchKeys.style.display = 'none';
- searchInput.onblur = () => searchKeys.style.display = 'block';
- searchInput.onkeydown = (event) => {
- if (event.key === 'Enter') {
- handleSearch();
- } else if (event.key === 'Escape') {
- if (document.getElementById('searchResults').style.display === 'none') {
- searchInput.blur();
- return
- }
- display_search_results("none");
- }
- };
- document.getElementById('searchButton').onclick(handleSearch);
-});
-
-window.onbeforeunload = function () {
- display_search_results("none");
-}
diff --git a/templates/assets/scripts/theme.js b/templates/assets/scripts/theme.js
deleted file mode 100644
index 544fb7336..000000000
--- a/templates/assets/scripts/theme.js
+++ /dev/null
@@ -1,43 +0,0 @@
-const playgrounds = [];
-
-document.addEventListener('DOMContentLoaded', () => {
- const theme = localStorage.getItem("theme");
- if (theme) {
- setTheme(theme);
- } else {
- const theme = document.querySelector("html").getAttribute("data-theme");
-
- localStorage.setItem("theme", theme);
- setTheme(theme);
- }
-
- const changeThemeButton = document.querySelector(".js-change-theme__action");
- changeThemeButton.addEventListener("click", () => {
- const currentTheme = document.documentElement.getAttribute("data-theme");
- const newTheme = currentTheme === "dark" ? "light" : "dark";
-
- setTheme(newTheme);
- });
-});
-
-function setTheme(newTheme) {
- const changeThemeButton = document.querySelector(".js-change-theme__action");
- document.documentElement.setAttribute("data-theme", newTheme);
- localStorage.setItem("theme", newTheme);
-
- const svgSun = changeThemeButton.querySelector(".sun");
- const svgMoon = changeThemeButton.querySelector(".moon");
- if (newTheme === "dark") {
- svgSun.style.display = "block";
- svgMoon.style.display = "none";
- } else {
- svgSun.style.display = "none";
- svgMoon.style.display = "block";
- }
-
- if (playgrounds !== undefined) {
- playgrounds.forEach(playground => {
- playground.setTheme(newTheme);
- });
- }
-}
diff --git a/templates/assets/scripts/v-docs.js b/templates/assets/scripts/v-docs.js
new file mode 100644
index 000000000..700b0a9e3
--- /dev/null
+++ b/templates/assets/scripts/v-docs.js
@@ -0,0 +1,593 @@
+// Function to fetch and cache the file content
+async function fetchFileContent(file_url) {
+ try {
+ const response = await fetch(file_url);
+ if (!response.ok) {
+ throw new Error('Network response was not ok ' + response.statusText);
+ }
+ return await response.text();
+ } catch (error) {
+ console.error('Failed to fetch file content:', error);
+ return '';
+ }
+
+}
+
+
+var vdocs = {
+ config: {
+ url_docs_md_original: 'https://github.com/vlang/v/blob/master/doc/docs.md',
+ url_docs_md_full_source: 'https://docs.vlang.io/assets/docs.md',
+ url_playground: 'https://play.vlang.io'
+ },
+ hydrate: function(){
+ this.ui.hydrateTheme();
+ this.ui.hydrateSidebar();
+ this.ui.hydrateSearch();
+ vdocs.examples.init();
+ },
+};
+
+vdocs.ui = {
+ btnChangeTheme: null,
+ currentTheme: 'dark',
+
+ tocPanel: null,
+ sidebar: null,
+ hydrateSidebar: function(){
+ this.sidebar = document.getElementById("sidebar-main");
+ this.tocPanel = document.getElementById("topics");
+
+ document.querySelector(".sidebar-open-btn").addEventListener("click", (event) => {
+ this.sidebar.style.setProperty('display', 'block')
+ })
+
+ document.querySelector(".sidebar-close-btn").addEventListener("click", (event) => {
+ this.sidebar.style.setProperty('display', 'none')
+ })
+
+ //scroll to show selected topic
+ const target = document.querySelector('.nav-entry.is-selected');
+ target.scrollIntoView({ behavior: 'smooth', block: 'center' });
+
+ },
+ hydrateTheme: function(){
+ this.btnChangeTheme = document.querySelector("header .change-theme");
+ this.currentTheme = document.querySelector("html").getAttribute("data-theme");
+
+ const theme = localStorage.getItem("theme");
+ if (theme) {
+ this.setTheme(theme);
+ } else {
+ this.setTheme(this.currentTheme);
+ }
+
+
+ this.btnChangeTheme.addEventListener("click", () => {
+ const new_theme = this.currentTheme =='dark' ? 'light': 'dark';
+ localStorage.setItem("theme", new_theme);
+ this.setTheme(new_theme);
+ });
+ },
+ setTheme: function(newTheme) {
+ this.currentTheme = newTheme;
+ document.querySelector("html").setAttribute("data-theme", newTheme);
+ const svgSun = this.btnChangeTheme.querySelector(".sun");
+ const svgMoon = this.btnChangeTheme.querySelector(".moon");
+ if (newTheme === "dark") {
+ svgSun.style.display = "block";
+ svgMoon.style.display = "none";
+ } else {
+ svgSun.style.display = "none";
+ svgMoon.style.display = "block";
+ }
+
+ vdocs.examples.onThemeChanged(newTheme);
+
+ },
+ searchInput: null,
+ searchResults: null,
+ searchVisible: false,
+ hydrateSearch: function(){
+ // Initialize the search functionality when the DOM is fully loaded
+ this.searchInput = document.getElementById('search-input');
+
+ const searchKeys = document.getElementById('search-kb-shortcut');
+ searchKeys.innerHTML = (navigator.platform.includes('Mac') ? '⌘' : 'Ctrl') + ' K';
+
+ var handleDocKey = (e)=>{
+ const key = event.key; // const {key} = event; in ES6+
+ if (key === "Escape") {
+ this.hideSearchResults();
+ }
+ };
+
+ const closeBtn = document.getElementById('search-results-close');
+ closeBtn.addEventListener('click', (event) => {
+ event.preventDefault();
+ this.hideSearchResults();
+ });
+
+ document.addEventListener('keydown', (event) => {
+
+ if ((event.ctrlKey || event.metaKey) && event.key === 'k') {
+ event.preventDefault();
+ this.searchInput.value = '';
+ this.searchInput.focus();
+ }else if (event.key === "Escape" && this.searchVisible) {
+ event.preventDefault();
+ this.hideSearchResults();
+ }
+ });
+
+ this.searchResults = document.getElementById('search-results');
+ this.searchResultsContainer = document.getElementById('search-result-container');
+
+ this.searchInput.onfocus = () => searchKeys.style.display = 'none';
+ this.searchInput.onblur = () => searchKeys.style.display = 'block';
+ this.searchInput.onkeydown = (event) => {
+
+ if (event.key === 'Enter') {
+ this.handleSearch();
+ } else if (event.key === 'Escape') {
+ if (this.searchResults.style.display === 'none') {
+ this.searchInput.blur();
+ return
+ }
+ this.hideSearchResults();
+ }
+ };
+
+ document.getElementById('search-button').addEventListener('click', (evt)=>{
+ this.handleSearch();
+ });
+
+ window.onbeforeunload = () => {
+ this.hideSearchResults("none");
+ };
+ },
+ helperGetLinkToSection: function(section){
+
+ const fixed_url = vdocs.titles_to_fnames[ section ];
+ if (fixed_url) { return fixed_url; }
+
+ const existing_html_page = vdocs.fnames[ section ];
+ if (existing_html_page) { return existing_html_page; }
+
+ // try with a simpler normalized version of the section title:
+ const slug = section.toLowerCase().replace(/\s+/g, '-').replace(/[^\w-]+/g, '');
+
+ const sfixed_url = vdocs.titles_to_fnames[ slug ];
+ if (sfixed_url) { return sfixed_url; }
+
+ const sexisting_html_page = vdocs.fnames[ slug ];
+ if (sexisting_html_page) { return sexisting_html_page; }
+
+ // probably a 3rd level or lower title, that currently has no reverse mapping; redirect to the main docs.md:
+ return vdocs.config.url_docs_md_original + '#' + slug;
+ },
+ hideSearchResults: function(){
+ this.searchVisible = false;
+
+ this.sidebar.classList.remove("search-results-open");
+ },
+ handleSearch: function(){
+ vdocs.search.topic( this.searchInput.value, (items) => this.showSearchResults(items) );
+
+ },
+ showSearchResults: function(items){
+
+ if (typeof items === 'string') {
+ return items;
+ }
+
+ let rows = items.map(item => {
+ const sectionLink = this.helperGetLinkToSection(item.section);
+
+ return `
+
+
${item.section}
+
${item.snippet}
+