Merge pull request #143 from joshuagl/joshuagl/bikeshed-initial

lukpueh · web-flow · commit d3ee69897919 · 2021-01-27T13:20:58.000+01:00
Initial conversion of the specification to bikeshed flavoured Markdown
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+tuf-spec.html
diff --git a/Makefile b/Makefile
@@ -0,0 +1,5 @@
+SHELL=/bin/bash -o pipefail
+.PHONY: local
+
+local: tuf-spec.md
+	bikeshed spec tuf-spec.md tuf-spec.html
diff --git a/check_release.py b/check_release.py
@@ -30,11 +30,11 @@
 
 SPEC_NAME = "tuf-spec.md"
 
-LAST_MODIFIED_PATTERN = "Last modified: **%d %B %Y**\n"
-LAST_MODIFIED_LINENO = 3
+LAST_MODIFIED_PATTERN = "Date: %Y-%m-%d\n"
+LAST_MODIFIED_LINENO = 6
 
-VERSION_PATTERN = r"^Version: \*\*(\d*)\.(\d*)\.(\d*)\*\*$"
-VERSION_LINENO = 5
+VERSION_PATTERN = r"^Text Macro: VERSION (\d*)\.(\d*)\.(\d*)$"
+VERSION_LINENO = 19
 
 class SpecError(Exception):
   """Common error message part. """
diff --git a/header.include b/header.include
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <title>[TITLE]</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <style data-fill-with="stylesheet">
+  </style>
+</head>
+<body class="h-entry">
+<div class="head">
+  <p data-fill-with="logo"></p>
+  <h1 id="title" class="p-name no-ref">[TITLE]</h1>
+  <h2 id="subtitle" class="no-num no-toc no-ref"> Version: [VERSION] <br/>
+    Last modified: <time class="dt-updated" datetime="[ISODATE]">[DATE]</time></h2>
+  <div data-fill-with="spec-metadata"></div>
+  <div data-fill-with="warning"></div>
+  <p class='copyright' data-fill-with='copyright'></p>
+  <hr title="Separator for header">
+</div>
+
+<div data-fill-with="at-risk"></div>
+
+<nav data-fill-with="table-of-contents" id="toc"></nav>
+<main>
diff --git a/tuf-spec.md b/tuf-spec.md
