From 79f3257437636c153bd9e66131495680ddf39afd Mon Sep 17 00:00:00 2001 From: Kévin Le Gouguec Date: Tue, 25 Aug 2020 23:12:57 +0200 Subject: Include stylesheets With relative links, so that I can just view HTML files on my disk without spawning a webserver. --- repo/www/generate-page.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'repo/www/generate-page.py') diff --git a/repo/www/generate-page.py b/repo/www/generate-page.py index c9fa0e4..e200a9e 100755 --- a/repo/www/generate-page.py +++ b/repo/www/generate-page.py @@ -1,6 +1,9 @@ #!/usr/bin/env python3 from argparse import ArgumentParser +from os import path + +from git import Repo from helpers import pandoc @@ -17,6 +20,10 @@ def parse_arguments(): '--lua-filter', dest='filters', action='append', help='Lua filter to run the page through.' ) + parser.add_argument( + '--stylesheet', dest='css', action='append', + help='CSS stylesheet to link to.' + ) parser.add_argument( '--title', help='Page title.' ) @@ -30,11 +37,16 @@ def parse_arguments(): def main(arguments): + repo_top = Repo(search_parent_directories=True).working_dir + path_to_top = path.relpath(repo_top, path.dirname(arguments.page)) + stylesheets = (path.join(path_to_top, s) for s in arguments.css) + pandoc( arguments.page, arguments.output, arguments.template, arguments.filters, + stylesheets, title=arguments.title, site_title=arguments.site_title ) -- cgit v1.2.3 From d0d869e06b30a1f8b7b539978caa0ed6123f9864 Mon Sep 17 00:00:00 2001 From: Kévin Le Gouguec Date: Wed, 26 Aug 2020 00:17:32 +0200 Subject: Add breadcrumbs Likewise, use relative links so that things work when just browsing files locally without a server. Next: tweak or remove redundant titles. --- repo/www/Makefile | 2 +- repo/www/crumbs.css | 31 +++++++++++++++++++++++++++++++ repo/www/generate-index.py | 9 ++++++--- repo/www/generate-page.py | 8 ++++++-- repo/www/helpers.py | 29 ++++++++++++++++++++++++++++- repo/www/template.html | 5 +++++ 6 files changed, 77 insertions(+), 7 deletions(-) create mode 100644 repo/www/crumbs.css (limited to 'repo/www/generate-page.py') diff --git a/repo/www/Makefile b/repo/www/Makefile index 86d1d98..1f32115 100644 --- a/repo/www/Makefile +++ b/repo/www/Makefile @@ -14,7 +14,7 @@ page_patterns = $(foreach ext,$(EXTENSIONS),'$(TOP_DIR)/**.$(ext)') page_folders = $(call dirnames,$(shell git ls-files $(page_patterns))) top_readme = $(shell git ls-files $(addprefix $(TOP_DIR)/README.,$(EXTENSIONS))) html_template = template.html -stylesheets_src = +stylesheets_src = crumbs.css lua_filters = convert-internal-links.lua all: site diff --git a/repo/www/crumbs.css b/repo/www/crumbs.css new file mode 100644 index 0000000..ef42620 --- /dev/null +++ b/repo/www/crumbs.css @@ -0,0 +1,31 @@ +nav.breadcrumb ol { + padding-left: 0; +} + +nav.breadcrumb li { + /* Prefer inline-block to inline, to prevent wrapping inside + * individual crumbs. */ + display: inline-block; +} + +/* Prefer + * li:not(:last-child)::after + * to + * li + li::before + * as I want crumbs and slashes to wrap like this: + * foo / bar / + * baz + * rather than like that: + * foo / bar + * / baz + */ +nav.breadcrumb li:not(:last-child)::after { + margin-left: 0.25em; + height: 0.8em; + font-weight: bold; + content: '/'; +} + +nav.breadcrumb li[aria-current="page"] { + font-weight: bold; +} diff --git a/repo/www/generate-index.py b/repo/www/generate-index.py index d615756..a993c41 100755 --- a/repo/www/generate-index.py +++ b/repo/www/generate-index.py @@ -10,7 +10,7 @@ from tempfile import NamedTemporaryFile from git import Repo -from helpers import deserialize_directories, pandoc +from helpers import deserialize_directories, generate_crumbs, pandoc def parse_arguments(): @@ -102,6 +102,7 @@ def main(arguments): path_to_top = '.' stylesheets = (path.join(path_to_top, s) for s in arguments.css) + variables = {'crumbs': generate_crumbs(Path(target)/'index')} if readme is not None: repo_top = Repo(search_parent_directories=True).working_dir @@ -118,7 +119,8 @@ def main(arguments): pandoc(readme_path, arguments.output, arguments.template, arguments.filters, stylesheets, title=page_title, - site_title=arguments.site_title, include_after=(toc.name,)) + site_title=arguments.site_title, include_after=(toc.name,), + variables=variables) return with NamedTemporaryFile(suffix='.md') as dummy_readme, \ @@ -128,7 +130,8 @@ def main(arguments): pandoc(dummy_readme.name, arguments.output, arguments.template, arguments.filters, stylesheets, title=index_title, - site_title=arguments.site_title, include_after=(toc.name,)) + site_title=arguments.site_title, include_after=(toc.name,), + variables=variables) if __name__ == '__main__': diff --git a/repo/www/generate-page.py b/repo/www/generate-page.py index e200a9e..8036cc5 100755 --- a/repo/www/generate-page.py +++ b/repo/www/generate-page.py @@ -2,10 +2,11 @@ from argparse import ArgumentParser from os import path +from pathlib import Path from git import Repo -from helpers import pandoc +from helpers import generate_crumbs, pandoc def parse_arguments(): @@ -41,6 +42,8 @@ def main(arguments): path_to_top = path.relpath(repo_top, path.dirname(arguments.page)) stylesheets = (path.join(path_to_top, s) for s in arguments.css) + page_path = Path(arguments.page).resolve().relative_to(repo_top) + pandoc( arguments.page, arguments.output, @@ -48,7 +51,8 @@ def main(arguments): arguments.filters, stylesheets, title=arguments.title, - site_title=arguments.site_title + site_title=arguments.site_title, + variables={'crumbs': generate_crumbs(page_path)} ) diff --git a/repo/www/helpers.py b/repo/www/helpers.py index 9b97902..80b8857 100644 --- a/repo/www/helpers.py +++ b/repo/www/helpers.py @@ -57,7 +57,7 @@ def deserialize_directories(directories): def pandoc(page, output, template, filters, stylesheets, title=None, - site_title=None, include_after=()): + site_title=None, include_after=(), variables=None): cmd = ( 'pandoc', '-s', page, '-o', output, '--template', template, *chain(*(('--lua-filter', f) for f in filters)), @@ -69,6 +69,33 @@ def pandoc(page, output, template, filters, stylesheets, title=None, cmd += ('-M', f'title={title}') if site_title is not None: cmd += ('-T', site_title) + if variables is not None: + cmd += tuple(chain( + *(('-V', f'{k}={v}') for k, v in variables.items()) + )) environ['LUA_PATH'] = '.cache/?.lua;;' run(cmd, check=True) + + +def generate_crumbs(target): + parts = ('(top)', *target.parts) + + if parts[-1] == 'index': + *crumbs, current = parts[:-1] + else: + crumbs = parts[:-1] + current, _ = path.splitext(parts[-1]) + + crumbs_li = ( + '
  • {crumb}
    • '.format( + link=(path.relpath(path.join(*crumbs[1:i], 'index.html'), + start=target.parent)), + crumb=crumb + ) + for i, crumb in enumerate(crumbs, start=1) + ) + + current_li = f'
  • {current}
    • ' + + return '\n'.join((*crumbs_li, current_li)) diff --git a/repo/www/template.html b/repo/www/template.html index 724cde4..f2b308d 100644 --- a/repo/www/template.html +++ b/repo/www/template.html @@ -33,6 +33,11 @@ $include-before$ $endfor$ $if(title)$
    +

    $title$

    $if(subtitle)$

    $subtitle$

    -- cgit v1.2.3 From 63a248e3dd9fc6857098c75ffbd49f72cf362c13 Mon Sep 17 00:00:00 2001 From: Kévin Le Gouguec Date: Fri, 28 Aug 2020 19:06:45 +0200 Subject: Make sure titles are not redundant with breadcrumbs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The logic for the various titles on any given page is: ∃README ∃title block ⇒ title block <header> <h1> ⇒ title block TOC <h1> ⇒ "Index for {target}" ∄title block <title> ⇒ "{target}" or "README" <header> <h1> ⇒ ∅ TOC <h1> ⇒ "Index for {target}" ∄README <title> ⇒ "Index for {target}" <header> <h1> ⇒ "Index" TOC <h1> ⇒ ∅ --- repo/www/Makefile | 6 +++--- repo/www/TODO | 3 +-- repo/www/generate-index.py | 39 ++++++++++++++++++++++----------------- repo/www/generate-page.py | 4 ++-- repo/www/helpers.py | 10 ++++++---- repo/www/template.html | 4 ++-- 6 files changed, 36 insertions(+), 30 deletions(-) (limited to 'repo/www/generate-page.py') diff --git a/repo/www/Makefile b/repo/www/Makefile index 1f32115..6c41b45 100644 --- a/repo/www/Makefile +++ b/repo/www/Makefile @@ -53,6 +53,9 @@ site: $(pages) $(indices) $(stylesheets) $(stylesheets) # directories (e.g. folders that only contain subfolders). html_folders = $(call dirnames,$(pages) $(indices)) +top_index = $(OUT_DIR)/index.html +subindices = $(filter-out $(top_index),$(indices)) + $(html_folders) $(stylesheets_dir) $(cache): mkdir -p $@ @@ -67,9 +70,6 @@ $(pages): $(OUT_DIR)/%.html: $(foreach s,$(stylesheets_src),--stylesheet style/$(s)) \ --template=$(html_template) $< $@ -top_index = $(OUT_DIR)/index.html -subindices = $(filter-out $(top_index),$(indices)) - $(top_index): index_options = $(subindices): index_options = --site-title="$$(cat $(title))" diff --git a/repo/www/TODO b/repo/www/TODO index dd1e670..5759e87 100644 --- a/repo/www/TODO +++ b/repo/www/TODO @@ -1,6 +1,5 @@ - compute "leak count" on toplevel index -- autogenerate nav -- autogenerate breadcrumbs +- use "{pagetitle} - {sitetitle})" for <title> - get stylin' - pandoc template - tufte css? at least sidenotes rather than footnotes diff --git a/repo/www/generate-index.py b/repo/www/generate-index.py index a993c41..3bce69d 100755 --- a/repo/www/generate-index.py +++ b/repo/www/generate-index.py @@ -92,17 +92,14 @@ def main(arguments): folders, files = list_files(arguments.site_tree, target) pages, readme = list_pages(files) + toc_title = f'Index for {target}' if target else 'Index' html_toc = format_toc(folders, pages) - if target: - index_title = f'Index for {target}' - path_to_top = path.relpath('.', target) - else: - index_title = 'Index' - path_to_top = '.' - + path_to_top = path.relpath('.', start=target) stylesheets = (path.join(path_to_top, s) for s in arguments.css) + variables = {'crumbs': generate_crumbs(Path(target)/'index')} + metadata = {} if readme is not None: repo_top = Repo(search_parent_directories=True).working_dir @@ -110,17 +107,20 @@ def main(arguments): # If the README doesn't have a title, give a default to pandoc # out-of-band. - page_title = None if has_title(readme_path) else 'README' + if not has_title(readme_path): + metadata['pagetitle'] = target or 'README' with NamedTemporaryFile(mode='w+') as toc: - toc.write('<h1>{title}</h1>\n'.format(title=index_title)) + toc.write(f'<h1>{toc_title}</h1>\n') toc.write(html_toc) toc.flush() - pandoc(readme_path, arguments.output, arguments.template, - arguments.filters, stylesheets, title=page_title, - site_title=arguments.site_title, include_after=(toc.name,), - variables=variables) + pandoc( + readme_path, arguments.output, + arguments.template, arguments.filters, stylesheets, + site_title=arguments.site_title, include_after=(toc.name,), + variables=variables, metadata=metadata + ) return with NamedTemporaryFile(suffix='.md') as dummy_readme, \ @@ -128,10 +128,15 @@ def main(arguments): toc.write(html_toc) toc.flush() - pandoc(dummy_readme.name, arguments.output, arguments.template, - arguments.filters, stylesheets, title=index_title, - site_title=arguments.site_title, include_after=(toc.name,), - variables=variables) + metadata['pagetitle'] = toc_title + metadata['title'] = 'Index' + + pandoc( + dummy_readme.name, arguments.output, + arguments.template, arguments.filters, stylesheets, + site_title=arguments.site_title, include_after=(toc.name,), + variables=variables, metadata=metadata + ) if __name__ == '__main__': diff --git a/repo/www/generate-page.py b/repo/www/generate-page.py index 8036cc5..967689e 100755 --- a/repo/www/generate-page.py +++ b/repo/www/generate-page.py @@ -50,9 +50,9 @@ def main(arguments): arguments.template, arguments.filters, stylesheets, - title=arguments.title, site_title=arguments.site_title, - variables={'crumbs': generate_crumbs(page_path)} + variables={'crumbs': generate_crumbs(page_path)}, + metadata={'pagetitle':arguments.title} ) diff --git a/repo/www/helpers.py b/repo/www/helpers.py index 80b8857..3d412b4 100644 --- a/repo/www/helpers.py +++ b/repo/www/helpers.py @@ -56,8 +56,8 @@ def deserialize_directories(directories): } -def pandoc(page, output, template, filters, stylesheets, title=None, - site_title=None, include_after=(), variables=None): +def pandoc(page, output, template, filters, stylesheets, site_title=None, + include_after=(), variables=None, metadata=None): cmd = ( 'pandoc', '-s', page, '-o', output, '--template', template, *chain(*(('--lua-filter', f) for f in filters)), @@ -65,14 +65,16 @@ def pandoc(page, output, template, filters, stylesheets, title=None, *chain(*(('--include-after-body', f) for f in include_after)) ) - if title is not None: - cmd += ('-M', f'title={title}') if site_title is not None: cmd += ('-T', site_title) if variables is not None: cmd += tuple(chain( *(('-V', f'{k}={v}') for k, v in variables.items()) )) + if metadata is not None: + cmd += tuple(chain( + *(('-M', f'{k}={v}') for k, v in metadata.items()) + )) environ['LUA_PATH'] = '.cache/?.lua;;' run(cmd, check=True) diff --git a/repo/www/template.html b/repo/www/template.html index f2b308d..3417e93 100644 --- a/repo/www/template.html +++ b/repo/www/template.html @@ -31,14 +31,15 @@ $endfor$ $for(include-before)$ $include-before$ $endfor$ -$if(title)$ <header id="title-block-header"> <nav class="breadcrumb" aria-label="Breadcrumb"> <ol> $crumbs$ </ol> </nav> +$if(title)$ <h1 class="title">$title$</h1> +$endif$ $if(subtitle)$ <p class="subtitle">$subtitle$</p> $endif$ @@ -49,7 +50,6 @@ $if(date)$ <p class="date">$date$</p> $endif$ </header> -$endif$ $if(toc)$ <nav id="$idprefix$TOC" role="doc-toc"> $if(toc-title)$ -- cgit v1.2.3 From b6cb7d009364ab63e09fe6febc15330edae0644a Mon Sep 17 00:00:00 2001 From: Kévin Le Gouguec <kevin.legouguec@gmail.com> Date: Fri, 28 Aug 2020 22:21:11 +0200 Subject: Move site title after page title Plenty of websites do this; on GNU/Linux most applications do this; I guess the goal is to make the most specific information go first, so that tabs remain identifiable as they become narrower. --- repo/www/TODO | 1 - repo/www/generate-index.py | 6 ++++-- repo/www/generate-page.py | 4 ++-- repo/www/helpers.py | 6 ++---- repo/www/template.html | 2 +- 5 files changed, 9 insertions(+), 10 deletions(-) (limited to 'repo/www/generate-page.py') diff --git a/repo/www/TODO b/repo/www/TODO index 5759e87..cd97605 100644 --- a/repo/www/TODO +++ b/repo/www/TODO @@ -1,5 +1,4 @@ - compute "leak count" on toplevel index -- use "{pagetitle} - {sitetitle})" for <title> - get stylin' - pandoc template - tufte css? at least sidenotes rather than footnotes diff --git a/repo/www/generate-index.py b/repo/www/generate-index.py index 3bce69d..16d1874 100755 --- a/repo/www/generate-index.py +++ b/repo/www/generate-index.py @@ -100,6 +100,8 @@ def main(arguments): variables = {'crumbs': generate_crumbs(Path(target)/'index')} metadata = {} + if arguments.site_title is not None: + metadata['sitetitle'] = arguments.site_title if readme is not None: repo_top = Repo(search_parent_directories=True).working_dir @@ -118,7 +120,7 @@ def main(arguments): pandoc( readme_path, arguments.output, arguments.template, arguments.filters, stylesheets, - site_title=arguments.site_title, include_after=(toc.name,), + include_after=(toc.name,), variables=variables, metadata=metadata ) return @@ -134,7 +136,7 @@ def main(arguments): pandoc( dummy_readme.name, arguments.output, arguments.template, arguments.filters, stylesheets, - site_title=arguments.site_title, include_after=(toc.name,), + include_after=(toc.name,), variables=variables, metadata=metadata ) diff --git a/repo/www/generate-page.py b/repo/www/generate-page.py index 967689e..cb2317b 100755 --- a/repo/www/generate-page.py +++ b/repo/www/generate-page.py @@ -50,9 +50,9 @@ def main(arguments): arguments.template, arguments.filters, stylesheets, - site_title=arguments.site_title, variables={'crumbs': generate_crumbs(page_path)}, - metadata={'pagetitle':arguments.title} + metadata={'pagetitle': arguments.title, + 'sitetitle': arguments.site_title} ) diff --git a/repo/www/helpers.py b/repo/www/helpers.py index 3d412b4..48ebccf 100644 --- a/repo/www/helpers.py +++ b/repo/www/helpers.py @@ -56,8 +56,8 @@ def deserialize_directories(directories): } -def pandoc(page, output, template, filters, stylesheets, site_title=None, - include_after=(), variables=None, metadata=None): +def pandoc(page, output, template, filters, stylesheets, include_after=(), + variables=None, metadata=None): cmd = ( 'pandoc', '-s', page, '-o', output, '--template', template, *chain(*(('--lua-filter', f) for f in filters)), @@ -65,8 +65,6 @@ def pandoc(page, output, template, filters, stylesheets, site_title=None, *chain(*(('--include-after-body', f) for f in include_after)) ) - if site_title is not None: - cmd += ('-T', site_title) if variables is not None: cmd += tuple(chain( *(('-V', f'{k}={v}') for k, v in variables.items()) diff --git a/repo/www/template.html b/repo/www/template.html index 3417e93..b4746d9 100644 --- a/repo/www/template.html +++ b/repo/www/template.html @@ -13,7 +13,7 @@ $endif$ $if(keywords)$ <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" /> $endif$ - <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$ + $pagetitle$$if(sitetitle)$ – $sitetitle$$endif$ -- cgit v1.2.3