Put project version and github URL in heading

irskep · Aug 27, 2024 · 98a5059 · 98a5059
1 parent 4b500ae
commit 98a5059
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 21 deletions.
diff --git a/docs/djockey.yaml b/docs/djockey.yaml
@@ -4,6 +4,9 @@ outputDir:
   gfm: out/gfm
 siteName: "Djockey"
 urlRoot: https://steveasleep.com/djockey
+projectInfo:
+  version: 0.0.1
+  githubURL: https://github.com/irskep/djockey
 
 outputFormats:
   html: true

diff --git a/docs/src/basics/configuration.djot b/docs/src/basics/configuration.djot
@@ -12,6 +12,9 @@ Djockey is pre-alpha and config options _will_ change.
 # djockey.yaml
 siteName: "Your name here"
 urlRoot: "https://your-docs-site-here"
+projectInfo:
+  version: 0.0.1
+  githubURL: https://github.com/your/project
 inputDir: "path to your docs"
 outputDir:
   html: "path to your HTML output"

diff --git a/src/types.ts b/src/types.ts
@@ -1,27 +1,6 @@
 import { Doc } from "@djot/djot";
 import { Environment } from "nunjucks";
 
-export type DjockeyDoc = {
-  docs: { content: Doc } & Record<string, Doc>;
-  title: string;
-  originalExtension: string;
-  absolutePath: string;
-  relativePath: string;
-  filename: string;
-  frontMatter: Record<string, unknown>;
-
-  // For use by plugins
-  data: Record<string, unknown>;
-};
-
-// These correspond to pandoc formats. Keep these two lines in sync.
-export type DjockeyInputFormat = "djot" | "gfm";
-export const ALL_INPUT_FORMATS: DjockeyInputFormat[] = ["djot", "gfm"];
-
-// Keep these two lines in sync.
-export type DjockeyOutputFormat = "html" | "gfm";
-export const ALL_OUTPUT_FORMATS: DjockeyOutputFormat[] = ["html", "gfm"];
-
 export type DjockeyConfig = {
   inputDir: string;
   outputDir: Record<DjockeyOutputFormat, string>;
@@ -32,6 +11,11 @@ export type DjockeyConfig = {
   numPasses: number;
   siteName: string;
 
+  projectInfo?: {
+    version?: string;
+    githubURL?: string;
+  };
+
   plugins: string[];
 
   html: {
@@ -46,6 +30,27 @@ export type DjockeyConfigResolved = DjockeyConfig & {
   urlRoot: string;
 };
 
+export type DjockeyDoc = {
+  docs: { content: Doc } & Record<string, Doc>;
+  title: string;
+  originalExtension: string;
+  absolutePath: string;
+  relativePath: string;
+  filename: string;
+  frontMatter: Record<string, unknown>;
+
+  // For use by plugins
+  data: Record<string, unknown>;
+};
+
+// These correspond to pandoc formats. Keep these two lines in sync.
+export type DjockeyInputFormat = "djot" | "gfm";
+export const ALL_INPUT_FORMATS: DjockeyInputFormat[] = ["djot", "gfm"];
+
+// Keep these two lines in sync.
+export type DjockeyOutputFormat = "html" | "gfm";
+export const ALL_OUTPUT_FORMATS: DjockeyOutputFormat[] = ["html", "gfm"];
+
 export type DjockeyRenderer = {
   identifier: DjockeyOutputFormat;
 

diff --git a/templates/html/base.njk b/templates/html/base.njk
@@ -24,6 +24,21 @@
 </svg>
 {%- endmacro -%}
 
+{%- macro header_project_info() -%}
+{% if config.projectInfo %}
+<div class="DJProjectInfo">
+  {%- if config.projectInfo.githubURL -%}
+  <div class="DJProjectInfo_Repo">
+    <a href="{{ confnig.projectInfo.githubURL }}">GitHub</a>
+  </div>
+  {%- endif %}
+  {%- if config.projectInfo.version %}
+  <div class="DJProjectInfo_Version">Version {{ config.projectInfo.version }}</div>
+  {%- endif -%}
+</div>
+{% endif %}
+{%- endmacro -%}
+
 <!doctype html>
 <html>
   <head>
@@ -53,6 +68,9 @@
           </button>
           <h1>{{ config.siteName }}</h1>
         </div>
+        <div class="DJHeader_Content_Group">
+          {{ header_project_info() }}
+        </div>
       </div>
     </header>
 

diff --git a/templates/html/static/dj-style.css b/templates/html/static/dj-style.css
@@ -72,6 +72,11 @@ th {
   padding: var(--ms);
 }
 
+.DJProjectInfo {
+  font-size: var(--fs-small);
+  color: var(--color-fg-2);
+}
+
 .DJFooter_Content {
   border-top: var(--border-weak);
   padding: var(--ms);