Skip to content

Commit

Permalink
Set pathes relatively (#29)
Browse files Browse the repository at this point in the history
- bring ide-extension to root
- remove then superflous css
- update README of how to build all pages locally
  • Loading branch information
dr0i committed Mar 25, 2024
1 parent 23c95dc commit 96561f7
Show file tree
Hide file tree
Showing 11 changed files with 55 additions and 491 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
16 changes: 8 additions & 8 deletions getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion getting-started.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
41 changes: 18 additions & 23 deletions ide-extensions/index.html → ide-extensions.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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>
Expand Down
10 changes: 5 additions & 5 deletions ide-extensions/index.md → ide-extensions.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
Loading

0 comments on commit 96561f7

Please sign in to comment.