feresaria/scripts/build-site.py

#!/usr/bin/env python3
"""Build Ferese's static website and handbook from the project Markdown docs."""
from pathlib import Path
from html import escape
import json
import re
import shutil
from urllib.parse import urlsplit
from markdown_it import MarkdownIt

ROOT = Path(__file__).resolve().parent.parent
OUTPUT = ROOT / 'build' / 'site'
REPO = 'https://github.com/ferese-wm/ferese'
PAGES = [
    ('index', 'Introduction', ROOT / 'site/content/index.md'),
    ('screenshots', 'Screenshots', ROOT / 'docs/screenshots.md'),
    ('why-ferese', 'Why Ferese', ROOT / 'docs/why-ferese.md'),
    ('installation', 'Installation', ROOT / 'docs/installation.md'),
    ('packaging', 'Packages and releases', ROOT / 'docs/packaging.md'),
    ('configuration', 'Configuration', ROOT / 'docs/configuration.md'),
    ('panel-configuration', 'Panel configuration', ROOT / 'docs/panel-configuration.md'),
    ('animation-model', 'Animation model', ROOT / 'docs/animation-model.md'),
    ('shortcuts', 'Shortcuts and gestures', ROOT / 'docs/shortcuts.md'),
    ('locking', 'Lock screen', ROOT / 'docs/locking.md'),
    ('screen-sharing', 'Screen sharing', ROOT / 'docs/screen-sharing.md'),
    ('portals', 'Desktop portals', ROOT / 'docs/portals.md'),
    ('development', 'Development', ROOT / 'docs/development.md'),
]
md = MarkdownIt('commonmark', {'html': False}).enable('table')
if OUTPUT.exists():
    shutil.rmtree(OUTPUT)
OUTPUT.mkdir(parents=True)
for name in ('index.html', 'home.css', 'handbook.css', 'styles.css', 'app.js'):
    shutil.copy2(ROOT / 'site' / name, OUTPUT / name)
(OUTPUT / 'assets').mkdir(exist_ok=True)
shutil.copytree(ROOT / 'site/assets', OUTPUT / 'assets', dirs_exist_ok=True)
shutil.copytree(ROOT / 'docs/images', OUTPUT / 'assets', dirs_exist_ok=True)
shutil.copytree(ROOT / 'assets/branding', OUTPUT / 'assets/branding')
(OUTPUT / 'docs').mkdir(exist_ok=True)
(OUTPUT / '.nojekyll').touch()
search_index = []


def rewrite_link(href, source):
    url = urlsplit(href)
    if url.scheme or url.netloc or not url.path:
        return href
    basename = Path(url.path).stem
    if url.path.endswith('.md') and basename in {page[0] for page in PAGES}:
        return f'{basename}.html' + (f'#{url.fragment}' if url.fragment else '')
    path = (source.parent / url.path).resolve()
    if path.is_relative_to(ROOT / 'docs/images'):
        return '../assets/' + path.relative_to(ROOT / 'docs/images').as_posix()
    destination = path.relative_to(ROOT)
    return f'{REPO}/blob/main/{destination}' + (f'#{url.fragment}' if url.fragment else '')


for page_number, (slug, title, source) in enumerate(PAGES):
    tokens = md.parse(source.read_text())
    toc, ids, sections = [], set(), []
    current = None
    for i, token in enumerate(tokens):
        if token.type == 'heading_open':
            heading = tokens[i + 1].content
            base = re.sub(r'[^\w\s-]', '', heading.lower()).strip()
            base = re.sub(r'[\s_]+', '-', base)
            anchor = base
            suffix = 1
            while anchor in ids:
                anchor = f'{base}-{suffix}'
                suffix += 1
            ids.add(anchor)
            token.attrSet('id', anchor)
            if token.tag != 'h1':
                toc.append((anchor, heading))
            current = {'page': title, 'heading': heading, 'url': f'{slug}.html#{anchor}', 'text': ''}
            sections.append(current)
        elif current and token.type in ('inline', 'fence', 'code_block'):
            current['text'] += token.content + ' '
        for child in token.children or []:
            if child.type == 'link_open':
                child.attrSet('href', rewrite_link(child.attrGet('href'), source))
            elif child.type == 'image':
                image = urlsplit(child.attrGet('src'))
                if not image.scheme and not image.netloc:
                    path = (source.parent / image.path).resolve()
                    relative = path.relative_to(ROOT / 'docs/images')
                    if not path.is_file():
                        raise FileNotFoundError(path)
                    child.attrSet('src', f'../assets/{relative.as_posix()}')
                child.attrSet('loading', 'lazy')
                child.attrSet('decoding', 'async')
    search_index.extend(sections)
    body = md.renderer.render(tokens, md.options, {})
    body = body.replace('<table>', '<div class="table-scroll" tabindex="0" role="region" aria-label="Reference table"><table>').replace('</table>', '</table></div>')
    navigation = ''.join(f'<a href="{s}.html"' + (' aria-current="page"' if s == slug else '') + f'>{escape(t)}</a>' for s, t, _ in PAGES)
    contents = ''.join(f'<a href="#{anchor}">{escape(heading)}</a>' for anchor, heading in toc)
    pager = ''
    if page_number:
        prev = PAGES[page_number - 1]
        pager += f'<a class="pager-previous" href="{prev[0]}.html"><small>Previous</small>← {escape(prev[1])}</a>'
    if page_number + 1 < len(PAGES):
        nxt = PAGES[page_number + 1]
        pager += f'<a class="pager-next" href="{nxt[0]}.html"><small>Next</small>{escape(nxt[1])} →</a>'
    mobile_contents = (
        f'<details class="mobile-contents"><summary>On this page</summary><nav aria-label="Page sections">{contents}</nav></details>'
        if contents else ''
    )
    doc = f'''<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="theme-color" content="#111821">
  <title>{escape(title)} — Ferese handbook</title>
  <meta name="description" content="{escape(title)} in the Ferese handbook: setup, configuration, and guides for your Wayland desktop.">
  <link rel="icon" href="../assets/branding/ferese.svg" type="image/svg+xml">
  <link rel="icon" href="../assets/favicon.ico" sizes="16x16 32x32 48x48">
  <link rel="icon" href="../assets/favicon-32.png" type="image/png" sizes="32x32">
  <link rel="stylesheet" href="../styles.css">
  <link rel="stylesheet" href="../handbook.css">
  <script src="../app.js" defer></script>
</head>
<body class="docs-page">
  <svg class="icon-definitions" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><defs>
    <symbol id="i-arrow" viewBox="0 0 24 24"><path d="M5 12h14M13 6l6 6-6 6"/></symbol>
    <symbol id="i-external" viewBox="0 0 24 24"><path d="M7 17 17 7M7 7h10v10"/></symbol>
  </defs></svg>
  <a class="skip" href="#main">Skip to content</a>
  <header class="site-header">
    <div class="header-inner page-width">
      <a class="brand" href="../" aria-label="Ferese home"><img src="../assets/branding/ferese.svg" width="34" height="34" alt=""><span>Ferese</span></a>
      <nav aria-label="Main navigation"><a href="../#make-room">The desktop</a><a href="../#appearance">Appearance</a><a href="./" aria-current="page">Handbook</a></nav>
      <div class="header-actions"><a class="small-button" href="installation.html">Get Ferese</a></div>
    </div>
  </header>
  <div class="docs-layout page-width">
    <aside class="docs-sidebar" aria-label="Handbook navigation">
      <div class="docs-search" hidden>
        <label class="sr-only" for="docs-search">Search the handbook</label>
        <input id="docs-search" type="search" placeholder="Search the handbook…" autocomplete="off" aria-controls="search-results">
        <div class="search-results" id="search-results" hidden></div>
        <p class="sr-only" id="search-status" role="status"></p>
      </div>
      <details class="handbook-navigation" open>
        <summary>Browse the handbook <svg class="icon" aria-hidden="true"><use href="#i-arrow"/></svg></summary>
        <nav aria-label="Documentation">{navigation}</nav>
      </details>
      <div class="sidebar-links">
        <a href="{REPO}/issues">Report an issue <svg class="icon" aria-hidden="true"><use href="#i-external"/></svg></a>
        <a href="../">Back to Ferese</a>
      </div>
    </aside>
    <main class="docs-article" id="main">
      <div class="breadcrumb"><a href="./">Handbook</a><span aria-hidden="true">/</span><span>{escape(title)}</span></div>
      {mobile_contents}
      <article class="prose">{body}</article>
      <a class="edit-link" href="{REPO}/blob/main/{source.relative_to(ROOT)}">View this guide on GitHub <svg class="icon" aria-hidden="true"><use href="#i-external"/></svg></a>
      <nav class="docs-pager" aria-label="Previous and next guide">{pager}</nav>
    </main>
    <aside class="docs-toc" aria-label="On this page">{'<p>On this page</p><nav>' + contents + '</nav>' if contents else ''}</aside>
  </div>
  <footer class="site-footer page-width">
    <a class="brand" href="../" aria-label="Ferese home"><img src="../assets/branding/ferese.svg" width="28" height="28" alt=""><span>Ferese</span></a>
    <span>Built in the open for Linux.</span>
    <nav aria-label="Footer navigation"><a href="./">Handbook</a><a href="{REPO}">GitHub <svg class="icon" aria-hidden="true"><use href="#i-external"/></svg></a></nav>
  </footer>
</body>
</html>'''
    (OUTPUT / 'docs' / f'{slug}.html').write_text(doc)
(OUTPUT / 'docs/search-index.json').write_text(json.dumps(search_index, ensure_ascii=False))
print(f'Built website and {len(PAGES)} handbook pages at {OUTPUT}')