Set pathes relatively (#29)

- bring ide-extension to root - remove then superflous css - update README of how to build all pages locally
metafacture · Mar 25, 2024 · 5039584 · 5039584
1 parent 23c95dc
commit 5039584
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 495 deletions.
diff --git a/.github/workflows/generate_html.yml b/.github/workflows/generate_html.yml
@@ -28,18 +28,18 @@ jobs:
             --standalone
             --title-prefix="Metafacture"
             getting-started.md
-      - name: Generate ide-extensions/index.html
+      - name: Generate ide-extensions.html
         uses: docker://pandoc/core:2.9
         with:
           args: >
-            --output=ide-extensions/index.html
+            --output=ide-extensions.html
             --include-before-body=navigation.html
             --css=../github-pandoc.css
             --standalone
             --title-prefix="Metafacture"
-            ide-extensions/index.md
+            ide-extensions.md
       - name: Commit html files
         uses: EndBug/add-and-commit@v5
         with:
           message: "Add newly generated html files by GitHub Actions."
-          add: "index.html getting-started.html ide-extensions/index.html --force"
+          add: "index.html getting-started.html ide-extensions/index.html --force"
diff --git a/README.md b/README.md
@@ -5,9 +5,9 @@ The HTML files are generated by Github Actions on every Push. If you want to tes
 1. Install [pandoc](https://pandoc.org/installing.html)
 2. Execute
     ```
-    pandoc --output=index.html --include-before-body=navigation.html --css=github-pandoc.css --standalone --title-prefix "Metafacture" index.md
+    pandoc --output=index.html --include-before-body=navigation.html --css=github-pandoc.css --standalone --title-prefix "Metafacture" index.md; pandoc --output=getting-started.html --include-before-body=navigation.html --css=github-pandoc.css --standalone --title-prefix "Metafacture" getting-started.md; pandoc --output=ide-extensions.html --include-before-body=navigation.html --css=github-pandoc.css --standalone --title-prefix "Metafacture" ide-extensions.md
     ```
-    for generating the index.html on root.
+    for generating index.html, getting-started.html and ide-extensions.html on root.
 
 # Page Content
 ## Main Page

diff --git a/ide-extensions/fix.vsix → fix.vsix b/ide-extensions/fix.vsix → fix.vsix
diff --git a/ide-extensions/flux.vsix → flux.vsix b/ide-extensions/flux.vsix → flux.vsix
diff --git a/getting-started.html b/getting-started.html
@@ -75,31 +75,31 @@
 code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
   </style>
   <link rel="stylesheet" href="github-pandoc.css" />
-  <link rel="Metafacture Icon" type="image/x-icon" href="/img/metafacture-icon.png">
+  <link rel="Metafacture Icon" type="image/x-icon" href="./img/metafacture-icon.png">
 </head>
 <body>
 
-<img src="/img/metafacture.png" alt="Metafacture" style="max-width:100%"/>
+<img src="./img/metafacture.png" alt="Metafacture" style="max-width:100%"/>
 
 <center>
     <b>
-        <a href="/index.html">Home</a>
+        <a href="./index.html">Home</a>
         &ensp;|&ensp;
-        <a href="/getting-started.html">Getting started</a>
+        <a href="./getting-started.html">Getting started</a>
         &ensp;|&ensp;
         <a href="https://github.com/metafacture/metafacture-documentation">Documentation</a>
         &ensp;|&ensp;
-        <a href="/ide-extensions/index.html">IDE Extensions</a>
+        <a href="./ide-extensions.html">IDE Extensions</a>
         &ensp;|&ensp;
         <a href="https://blog.metafacture.org">Blog</a>
         &ensp;|&ensp;
         <a href="https://metafacture.org/playground">Playground</a>
         &ensp;&ensp;
         </br>
-        <a href='https://openbiblio.social/@metafacture'><img src='/img/Mastodon.png'/></a>
+        <a href='https://openbiblio.social/@metafacture'><img src='./img/Mastodon.png'/></a>
 
-        <a href='https://twitter.com/metafacture'><img src='/img/Twitter.png'/></a>
-        <a href='https://github.com/metafacture'><img src='/img/GitHub.png'/></a>
+        <a href='https://twitter.com/metafacture'><img src='./img/Twitter.png'/></a>
+        <a href='https://github.com/metafacture'><img src='./img/GitHub.png'/></a>
     </b>
 </center>
 <header id="title-block-header">

diff --git a/getting-started.md b/getting-started.md
@@ -1,7 +1,7 @@
 ---
 title: "Getting started"
 header-includes:
-    <link rel="Metafacture Icon" type="image/x-icon" href="/img/metafacture-icon.png">
+    <link rel="Metafacture Icon" type="image/x-icon" href="./img/metafacture-icon.png">
 ---
 
 ## Playground

diff --git a/ide-extensions/index.html → ide-extensions.html b/ide-extensions/index.html → ide-extensions.html
@@ -5,43 +5,38 @@
   <meta name="generator" content="pandoc" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
   <title>Metafacture – IDE Extensions</title>
-  <style>
-    code{white-space: pre-wrap;}
-    span.smallcaps{font-variant: small-caps;}
-    span.underline{text-decoration: underline;}
-    div.column{display: inline-block; vertical-align: top; width: 50%;}
-    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
-    ul.task-list{list-style: none;}
+  <style type="text/css">
+      code{white-space: pre-wrap;}
+      span.smallcaps{font-variant: small-caps;}
+      span.underline{text-decoration: underline;}
+      div.column{display: inline-block; vertical-align: top; width: 50%;}
   </style>
-  <link rel="stylesheet" href="../github-pandoc.css" />
-  <!--[if lt IE 9]>
-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-  <![endif]-->
-  <link rel="Metafacture Icon" type="image/x-icon" href="/img/metafacture-icon.png">
+  <link rel="stylesheet" href="github-pandoc.css" />
+  <link rel="Metafacture Icon" type="image/x-icon" href="./img/metafacture-icon.png">
 </head>
 <body>
 
-<img src="/img/metafacture.png" alt="Metafacture" style="max-width:100%"/>
+<img src="./img/metafacture.png" alt="Metafacture" style="max-width:100%"/>
 
 <center>
     <b>
-        <a href="/index.html">Home</a>
+        <a href="./index.html">Home</a>
         &ensp;|&ensp;
-        <a href="/getting-started.html">Getting started</a>
+        <a href="./getting-started.html">Getting started</a>
         &ensp;|&ensp;
         <a href="https://github.com/metafacture/metafacture-documentation">Documentation</a>
         &ensp;|&ensp;
-        <a href="/ide-extensions/index.html">IDE Extensions</a>
+        <a href="./ide-extensions.html">IDE Extensions</a>
         &ensp;|&ensp;
         <a href="https://blog.metafacture.org">Blog</a>
         &ensp;|&ensp;
         <a href="https://metafacture.org/playground">Playground</a>
         &ensp;&ensp;
         </br>
-        <a href='https://openbiblio.social/@metafacture'><img src='/img/Mastodon.png'/></a>
+        <a href='https://openbiblio.social/@metafacture'><img src='./img/Mastodon.png'/></a>
 
-        <a href='https://twitter.com/metafacture'><img src='/img/Twitter.png'/></a>
-        <a href='https://github.com/metafacture'><img src='/img/GitHub.png'/></a>
+        <a href='https://twitter.com/metafacture'><img src='./img/Twitter.png'/></a>
+        <a href='https://github.com/metafacture'><img src='./img/GitHub.png'/></a>
     </b>
 </center>
 <header id="title-block-header">
@@ -58,14 +53,14 @@ <h2 id="setup-a-vs-code-codium-extension">Setup a VS Code / Codium extension</h2
 <h2 id="usage">Usage</h2>
 <h3 id="flux">Flux</h3>
 <p>After installing the IDE extension to VS Code / Codium open a Flux file, for example <a href="https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill-to-oersi.flux">this one</a>. It should look like this:</p>
-<p><img src="/img/digill-to-oersi_flux.JPG" alt="Flux editor" style="max-width:100%"/></p>
+<p><img src="./img/digill-to-oersi_flux.JPG" alt="Flux editor" style="max-width:100%"/></p>
 <p>If you delete for example a necessary bracket you will see in the Problems section that the extension detects problems with the Flux file:</p>
-<p><img src="/img/digill-to-oersi_flux_problem.JPG" alt="Flux editor with problems" style="max-width:100%"/></p>
+<p><img src="./img/digill-to-oersi_flux_problem.JPG" alt="Flux editor with problems" style="max-width:100%"/></p>
 <h3 id="fix">Fix</h3>
 <p>After installing the IDE extension to VS Code / Codium open a Flux file, for example <a href="https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill.fix">this one</a>. It should look like this:</p>
-<p><img src="/img/digill_fix.JPG" alt="Fix editor" style="max-width:100%"/></p>
+<p><img src="./img/digill_fix.JPG" alt="Fix editor" style="max-width:100%"/></p>
 <p>If you remove a closing <code>end</code> you will see in the Problems section that the extension detects the missing <code>end</code>:</p>
-<p><img src="/img/digill_fix_problem.JPG" alt="Fix editor with problems" style="max-width:100%"/></p>
+<p><img src="./img/digill_fix_problem.JPG" alt="Fix editor with problems" style="max-width:100%"/></p>
 <h2 id="github">GitHub</h2>
 <p>To report issues, see the code, and contribute to the projects, visit: <a href="https://github.com/metafacture/metafacture-fix">Fix Repository</a>, <a href="https://github.com/metafacture/metafacture-flux">Flux Repository</a>.</p>
 </body>

diff --git a/ide-extensions/index.md → ide-extensions.md b/ide-extensions/index.md → ide-extensions.md
@@ -1,7 +1,7 @@
 ---
 title: "IDE Extensions"
 header-includes:
-    <link rel="Metafacture Icon" type="image/x-icon" href="/img/metafacture-icon.png">
+    <link rel="Metafacture Icon" type="image/x-icon" href="./img/metafacture-icon.png">
 ---
 
 ## Overview
@@ -22,21 +22,21 @@ There are different ways to install extensions for VS Code / Codium.
 
 After installing the IDE extension to VS Code / Codium open a Flux file, for example [this one](https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill-to-oersi.flux). It should look like this:
 
-<img src="/img/digill-to-oersi_flux.JPG" alt="Flux editor" style="max-width:100%"/>
+<img src="./img/digill-to-oersi_flux.JPG" alt="Flux editor" style="max-width:100%"/>
 
 If you delete for example a necessary bracket you will see in the Problems section that the extension detects problems with the Flux file:
 
-<img src="/img/digill-to-oersi_flux_problem.JPG" alt="Flux editor with problems" style="max-width:100%"/>
+<img src="./img/digill-to-oersi_flux_problem.JPG" alt="Flux editor with problems" style="max-width:100%"/>
 
 ### Fix
 
 After installing the IDE extension to VS Code / Codium open a Flux file, for example [this one](https://gitlab.com/oersi/oersi-etl/-/blob/master/data/production/digill/digill.fix). It should look like this:
 
-<img src="/img/digill_fix.JPG" alt="Fix editor" style="max-width:100%"/>
+<img src="./img/digill_fix.JPG" alt="Fix editor" style="max-width:100%"/>
 
 If you remove a closing `end` you will see in the Problems section that the extension detects the missing `end`:
 
-<img src="/img/digill_fix_problem.JPG" alt="Fix editor with problems" style="max-width:100%"/>
+<img src="./img/digill_fix_problem.JPG" alt="Fix editor with problems" style="max-width:100%"/>
 
 ## GitHub