reticulum_website/build.py

import markdown
import os

SOURCES_PATH = "./source"
BUILD_PATH = "./build"
INPUT_ENCODING = "utf-8"
OUTPUT_ENCODING = "utf-8"

document_start = """
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="css/water.css?v=6">
<meta charset="utf-8"/>
<title>Reticulum Network</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
"""

document_end = """
</body>
</html>
"""

langs_md = """<div class="top_menu lang_menu">{LANGS}</div>"""
menu_md = """<div class="top_menu">[{RETICULUM}](index{LANG_EXT}.html) | [{START}](start{LANG_EXT}.html) | [{HARDWARE}](hardware{LANG_EXT}.html) | [{TESTNET}](connect{LANG_EXT}.html) | [{MANUAL}](docs{LANG_EXT}.html) | [{CRYPTO}](crypto{LANG_EXT}.html) | [{CREDITS}](credits{LANG_EXT}.html) | [{SOURCE}](https://github.com/markqvist/reticulum) | [{DONATE}](donate{LANG_EXT}.html)</div>"""

primary_lang = "en"
langs = [
    {"name": "Deutsch", "ext": "de"},
    {"name": "English", "ext": "en"},
    {"name": "Nederlands", "ext": "nl"},
    {"name": "Polski", "ext": "pl"},
    {"name": "Español", "ext": "es"},
    {"name": "Português", "ext": "pt-br"},
    {"name": "Türkçe", "ext": "tr"},
    {"name": "日本語", "ext": "jp"},
    {"name": "简体中文", "ext": "zh-cn"},
]

menu_translations = {
    "en": {
        "RETICULUM": "Reticulum",
        "START": "Start",
        "HARDWARE": "Hardware",
        "TESTNET": "Testnet",
        "MANUAL": "Manual",
        "CRYPTO": "Crypto",
        "CREDITS": "Credits",
        "SOURCE": "Source",
        "DONATE": "Donate",
    },
    "tr": {
        "RETICULUM": "Reticulum",
        "START": "Başlat",
        "HARDWARE": "Donanım",
        "TESTNET": "Test Ağı",
        "MANUAL": "Kılavuz",
        "CRYPTO": "Şifreleme",
        "CREDITS": "Hakkında",
        "SOURCE": "Kaynak",
        "DONATE": "Destekle",
    },
    "nl": {
        "RETICULUM": "Reticulum",
        "START": "Start",
        "HARDWARE": "Hardware",
        "TESTNET": "Testnet",
        "MANUAL": "Handleiding",
        "CRYPTO": "Crypto",
        "CREDITS": "Dankwoord",
        "SOURCE": "Broncode",
        "DONATE": "Doneren",
    },
    "jp": {
        "RETICULUM": "レチキュラム",
        "START": "開始",
        "HARDWARE": "ハードウェア",
        "TESTNET": "テストネット",
        "MANUAL": "マニュアル",
        "CRYPTO": "暗号",
        "CREDITS": "クレジット",
        "SOURCE": "ソース",
        "DONATE": "寄付",
    },
    "de": {
        "RETICULUM": "Reticulum",
        "START": "Los Geht's",
        "HARDWARE": "Hardware",
        "TESTNET": "Testnetz",
        "MANUAL": "Handbuch",
        "CRYPTO": "Krypto",
        "CREDITS": "Credits",
        "SOURCE": "Quellcode",
        "DONATE": "Unterstützen",
    },
    "pl": {
        "RETICULUM": "Reticulum",
        "START": "Jak Zacząć",
        "HARDWARE": "Hardware",
        "TESTNET": "Testnet",
        "MANUAL": "Podręcznik",
        "CRYPTO": "Krypto",
        "CREDITS": "Zasługi",
        "SOURCE": "Kod Źródłowy",
        "DONATE": "Darowizna",
    },
    "pt-br": {
        "RETICULUM": "Reticulum",
        "START": "Começar",
        "HARDWARE": "Hardware",
        "TESTNET": "Rede de Teste",
        "MANUAL": "Manual",
        "CRYPTO": "Cripto",
        "CREDITS": "Créditos",
        "SOURCE": "Código",
        "DONATE": "Ajude",
    },
    "es": {
        "RETICULUM": "Reticulum",
        "START": "Empezar",
        "HARDWARE": "Hardware",
        "TESTNET": "Testnet",
        "MANUAL": "Manual",
        "CRYPTO": "Crypto",
        "CREDITS": "Creditos",
        "SOURCE": "Código fuente",
        "DONATE": "Donar",
    },
    "zh-cn": {
        "RETICULUM": "Reticulum",
        "START": "开始使用",
        "HARDWARE": "硬件要求",
        "TESTNET": "测试网络",
        "MANUAL": "阅读手册",
        "CRYPTO": "密码学",
        "CREDITS": "致谢",
        "SOURCE": "源代码",
        "DONATE": "支持开发",
    },
}


def get_page_lang(page):
    page_lang = primary_lang
    for lang in langs:
        base_name = mdf.replace(".md", "")
        if lang["ext"] != primary_lang:
            if base_name.endswith(lang["ext"]):
                page_lang = lang["ext"]
    return page_lang


def get_languages_md(page):
    page = page.replace(SOURCES_PATH, ".")
    current_page_lang = get_page_lang(page)
    if current_page_lang != primary_lang:
        page_base_name = page.replace("_" + current_page_lang + ".md", "")
    else:
        page_base_name = page.replace(".md", "")

    lang_list = ""
    for lang_entry in langs:
        lang = lang_entry["name"]
        lang_ext = lang_entry["ext"]
        if lang_ext != primary_lang:
            lang_ext_str = "_" + lang_ext
        else:
            lang_ext_str = ""

        link_target = page_base_name + lang_ext_str + ".html"
        link_md = "[" + lang + "](" + link_target + ") | "
        lang_list += link_md

    return langs_md.replace("{LANGS}", lang_list[:-3])


def get_menu_md(lang):
    local_menu_md = menu_md
    for entry in menu_translations[lang]:
        local_menu_md = local_menu_md.replace(
            "{" + entry + "}", menu_translations[lang][entry]
        )

    return local_menu_md


def scan_pages(base_path):
    files = [
        file
        for file in os.listdir(base_path)
        if os.path.isfile(os.path.join(base_path, file)) and file[:1] != "."
    ]
    directories = [
        file
        for file in os.listdir(base_path)
        if os.path.isdir(os.path.join(base_path, file)) and file[:1] != "."
    ]

    page_sources = []

    for file in files:
        if file.endswith(".md"):
            page_sources.append(base_path + "/" + file)

    for directory in directories:
        page_sources.append(scan_pages(base_path + "/" + directory))

    return page_sources


source_files = scan_pages(SOURCES_PATH)

for mdf in source_files:
    with open(mdf, "rb") as f:
        page_lang = get_page_lang(mdf)

        if page_lang != primary_lang:
            page_lang_ext = "_" + page_lang
        else:
            page_lang_ext = ""

        md = f.read().decode(INPUT_ENCODING)
        page_md = "<center>" + get_languages_md(mdf) + "" + get_menu_md(page_lang).replace("{LANG_EXT}", page_lang_ext) + "</center>\n\n" + md
        html = markdown.markdown(
            page_md, extensions=["markdown.extensions.fenced_code"]
        )
        html = document_start + html + document_end

        of = BUILD_PATH + mdf.replace(SOURCES_PATH, "").replace(".md", ".html")
        with open(of, "wb") as wf:
            wf.write(html.encode(OUTPUT_ENCODING))
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								import markdown
 								import os
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								SOURCES_PATH = "./source"
 								BUILD_PATH = "./build"
 								INPUT_ENCODING = "utf-8"
 								OUTPUT_ENCODING = "utf-8"
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
 								document_start = """
 								<!doctype html>
 								<html>
 								<head>
-												Updated page width

											
										
										
											2023-12-25 06:08:56 -05:00
+								<link rel="stylesheet" href="css/water.css?v=6">
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								<meta charset="utf-8"/>
 								<title>Reticulum Network</title>
-												Responsive Viewport

This change will make the website easier to read at smaller viewport widths.
											
										
										
											2022-07-03 14:38:28 -04:00
+								<meta name="viewport" content="width=device-width, initial-scale=1.0">
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								</head>
 								<body>
 								"""
 								document_end = """
 								</body>
 								</html>
 								"""
-												Updated CSS

											
										
										
											2022-11-14 05:26:59 -05:00
+								langs_md = """<div class="top_menu lang_menu">{LANGS}</div>"""
 								menu_md = """<div class="top_menu">[{RETICULUM}](index{LANG_EXT}.html) | [{START}](start{LANG_EXT}.html) | [{HARDWARE}](hardware{LANG_EXT}.html) | [{TESTNET}](connect{LANG_EXT}.html) | [{MANUAL}](docs{LANG_EXT}.html) | [{CRYPTO}](crypto{LANG_EXT}.html) | [{CREDITS}](credits{LANG_EXT}.html) | [{SOURCE}](https://github.com/markqvist/reticulum) | [{DONATE}](donate{LANG_EXT}.html)</div>"""
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								primary_lang = "en"
 								langs = [
-												Added menu translation and updated links

											
										
										
											2022-11-15 14:50:51 -05:00
+								    {"name": "Deutsch", "ext": "de"},
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								    {"name": "English", "ext": "en"},
-												Updated menu order

											
										
										
											2024-01-15 07:04:59 -05:00
+								    {"name": "Nederlands", "ext": "nl"},
-												Added polish translation

											
										
										
											2022-11-29 11:12:07 -05:00
+								    {"name": "Polski", "ext": "pl"},
-												feat(build): Add spanish

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:16:25 -04:00
+								    {"name": "Español", "ext": "es"},
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								    {"name": "Português", "ext": "pt-br"},
-												Updated language order

											
										
										
											2023-12-25 06:03:23 -05:00
+								    {"name": "Türkçe", "ext": "tr"},
 								    {"name": "日本語", "ext": "jp"},
-												Add menu translation for Chinese.
											
										
										
											2023-12-25 14:01:44 -05:00
+								    {"name": "简体中文", "ext": "zh-cn"},
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								]
 								menu_translations = {
 								    "en": {
 								        "RETICULUM": "Reticulum",
 								        "START": "Start",
 								        "HARDWARE": "Hardware",
 								        "TESTNET": "Testnet",
 								        "MANUAL": "Manual",
 								        "CRYPTO": "Crypto",
 								        "CREDITS": "Credits",
 								        "SOURCE": "Source",
 								        "DONATE": "Donate",
 								    },
-												Added translation for menu

											
										
										
											2023-12-24 22:12:26 -05:00
+								    "tr": {
 								        "RETICULUM": "Reticulum",
 								        "START": "Başlat",
 								        "HARDWARE": "Donanım",
 								        "TESTNET": "Test Ağı",
 								        "MANUAL": "Kılavuz",
 								        "CRYPTO": "Şifreleme",
 								        "CREDITS": "Hakkında",
 								        "SOURCE": "Kaynak",
-												Added translation for menu

											
										
										
											2023-12-24 22:20:35 -05:00
+								        "DONATE": "Destekle",
-												Added translation for menu

											
										
										
											2023-12-24 22:12:26 -05:00
+								    },
-												Update build.py

Dutch translation
											
										
										
											2024-01-14 22:14:10 -05:00
+								    "nl": {
 								        "RETICULUM": "Reticulum",
 								        "START": "Start",
 								        "HARDWARE": "Hardware",
 								        "TESTNET": "Testnet",
 								        "MANUAL": "Handleiding",
 								        "CRYPTO": "Crypto",
 								        "CREDITS": "Dankwoord",
 								        "SOURCE": "Broncode",
-												Update build.py
											
										
										
											2024-01-15 14:01:00 -05:00
+								        "DONATE": "Doneren",
-												Update build.py

Dutch translation
											
										
										
											2024-01-14 22:14:10 -05:00
+								    },
-												Added translation for menu

											
										
										
											2023-12-24 22:12:26 -05:00
+								    "jp": {
 								        "RETICULUM": "レチキュラム",
 								        "START": "開始",
 								        "HARDWARE": "ハードウェア",
 								        "TESTNET": "テストネット",
 								        "MANUAL": "マニュアル",
 								        "CRYPTO": "暗号",
 								        "CREDITS": "クレジット",
 								        "SOURCE": "ソース",
 								        "DONATE": "寄付",
 								    },
-												Added menu translation and updated links

											
										
										
											2022-11-15 14:50:51 -05:00
+								    "de": {
 								        "RETICULUM": "Reticulum",
 								        "START": "Los Geht's",
 								        "HARDWARE": "Hardware",
 								        "TESTNET": "Testnetz",
 								        "MANUAL": "Handbuch",
 								        "CRYPTO": "Krypto",
 								        "CREDITS": "Credits",
 								        "SOURCE": "Quellcode",
 								        "DONATE": "Unterstützen",
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								    },
 								    "pl": {
-												Added polish translation

											
										
										
											2022-11-29 11:12:07 -05:00
+								        "RETICULUM": "Reticulum",
-												Fixes for polish translation

											
										
										
											2022-11-30 15:02:45 -05:00
+								        "START": "Jak Zacząć",
-												Added polish translation

											
										
										
											2022-11-29 11:12:07 -05:00
+								        "HARDWARE": "Hardware",
 								        "TESTNET": "Testnet",
-												Added polish menu titles

											
										
										
											2022-11-29 12:03:28 -05:00
+								        "MANUAL": "Podręcznik",
 								        "CRYPTO": "Krypto",
 								        "CREDITS": "Zasługi",
-												Fixes for polish translation

											
										
										
											2022-11-30 15:02:45 -05:00
+								        "SOURCE": "Kod Źródłowy",
 								        "DONATE": "Darowizna",
-												Added menu translation and updated links

											
										
										
											2022-11-15 14:50:51 -05:00
+								    },
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								    "pt-br": {
 								        "RETICULUM": "Reticulum",
 								        "START": "Começar",
 								        "HARDWARE": "Hardware",
 								        "TESTNET": "Rede de Teste",
 								        "MANUAL": "Manual",
 								        "CRYPTO": "Cripto",
 								        "CREDITS": "Créditos",
 								        "SOURCE": "Código",
 								        "DONATE": "Ajude",
-												Add menu translation for Chinese.
											
										
										
											2023-12-25 14:01:44 -05:00
+								    },
-												feat(build): Add spanish

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:16:25 -04:00
+								    "es": {
 								        "RETICULUM": "Reticulum",
-												fix(docs): Fix Typos, markdown & spell

Small fixes for things that sounded a bit weird in the language and broken markdown in some paragraphs.

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-23 18:13:41 -04:00
+								        "START": "Empezar",
-												feat(build): Add spanish

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:16:25 -04:00
+								        "HARDWARE": "Hardware",
 								        "TESTNET": "Testnet",
 								        "MANUAL": "Manual",
 								        "CRYPTO": "Crypto",
 								        "CREDITS": "Creditos",
 								        "SOURCE": "Código fuente",
 								        "DONATE": "Donar",
 								    },
-												Add menu translation for Chinese.
											
										
										
											2023-12-25 14:01:44 -05:00
+								    "zh-cn": {
 								        "RETICULUM": "Reticulum",
 								        "START": "开始使用",
 								        "HARDWARE": "硬件要求",
 								        "TESTNET": "测试网络",
 								        "MANUAL": "阅读手册",
 								        "CRYPTO": "密码学",
 								        "CREDITS": "致谢",
 								        "SOURCE": "源代码",
 								        "DONATE": "支持开发",
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								    },
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								}
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								def get_page_lang(page):
 								    page_lang = primary_lang
 								    for lang in langs:
 								        base_name = mdf.replace(".md", "")
 								        if lang["ext"] != primary_lang:
 								            if base_name.endswith(lang["ext"]):
 								                page_lang = lang["ext"]
 								    return page_lang
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								def get_languages_md(page):
 								    page = page.replace(SOURCES_PATH, ".")
 								    current_page_lang = get_page_lang(page)
 								    if current_page_lang != primary_lang:
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        page_base_name = page.replace("_" + current_page_lang + ".md", "")
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								    else:
 								        page_base_name = page.replace(".md", "")
 								    lang_list = ""
 								    for lang_entry in langs:
 								        lang = lang_entry["name"]
 								        lang_ext = lang_entry["ext"]
 								        if lang_ext != primary_lang:
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								            lang_ext_str = "_" + lang_ext
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								        else:
 								            lang_ext_str = ""
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        link_target = page_base_name + lang_ext_str + ".html"
 								        link_md = "[" + lang + "](" + link_target + ") | "
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								        lang_list += link_md
-												Fixed missing space

											
										
										
											2022-11-12 12:20:10 -05:00
+								    return langs_md.replace("{LANGS}", lang_list[:-3])
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
 								def get_menu_md(lang):
 								    local_menu_md = menu_md
 								    for entry in menu_translations[lang]:
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        local_menu_md = local_menu_md.replace(
 								            "{" + entry + "}", menu_translations[lang][entry]
 								        )
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
 								    return local_menu_md
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								def scan_pages(base_path):
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								    files = [
 								        file
 								        for file in os.listdir(base_path)
 								        if os.path.isfile(os.path.join(base_path, file)) and file[:1] != "."
 								    ]
 								    directories = [
 								        file
 								        for file in os.listdir(base_path)
 								        if os.path.isdir(os.path.join(base_path, file)) and file[:1] != "."
 								    ]
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
 								    page_sources = []
 								    for file in files:
 								        if file.endswith(".md"):
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								            page_sources.append(base_path + "/" + file)
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
 								    for directory in directories:
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        page_sources.append(scan_pages(base_path + "/" + directory))
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
 								    return page_sources
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								source_files = scan_pages(SOURCES_PATH)
 								for mdf in source_files:
 								    with open(mdf, "rb") as f:
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								        page_lang = get_page_lang(mdf)
 								        if page_lang != primary_lang:
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								            page_lang_ext = "_" + page_lang
-												Added multilingual support to build script

											
										
										
											2022-11-12 04:32:05 -05:00
+								        else:
 								            page_lang_ext = ""
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								        md = f.read().decode(INPUT_ENCODING)
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        page_md = "<center>" + get_languages_md(mdf) + "" + get_menu_md(page_lang).replace("{LANG_EXT}", page_lang_ext) + "</center>\n\n" + md
 								        html = markdown.markdown(
 								            page_md, extensions=["markdown.extensions.fenced_code"]
 								        )
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								        html = document_start + html + document_end
-												refactor: Just a little formatting here and there

Signed-off-by: nothingbutlucas <69118979+nothingbutlucas@users.noreply.github.com>

											
										
										
											2024-04-22 19:18:06 -04:00
+								        of = BUILD_PATH + mdf.replace(SOURCES_PATH, "").replace(".md", ".html")
-												Added website

											
										
										
											2022-07-01 09:47:15 -04:00
+								        with open(of, "wb") as wf:
 								            wf.write(html.encode(OUTPUT_ENCODING))