Skip to content

Fix local build #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/generate_html.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
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.
166 changes: 81 additions & 85 deletions getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,105 +5,101 @@
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Metafacture – Getting started</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;}
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
<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>
<style type="text/css">
a.sourceLine { display: inline-block; line-height: 1.25; }
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
a.sourceLine:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode { white-space: pre; position: relative; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
code.sourceCode { white-space: pre-wrap; }
a.sourceLine { text-indent: -1em; padding-left: 1em; }
}
pre.numberSource a.sourceLine
{ position: relative; left: -4em; }
pre.numberSource a.sourceLine::before
{ content: attr(title);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; pointer-events: all; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
a.sourceLine::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</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="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://metafacture.github.io/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 @@ -122,11 +118,11 @@ <h2 id="using-metafacture-as-a-java-library">Using Metafacture as a Java library
<p>If you want to use Metafacture in your own Java projects all you need is to add some dependencies to your project. As of Metafacture 5, the single metafacture-core package has been replaced with a number of domain-specific packages. You can find the list of packages on <a href="https://search.maven.org/search?q=g:org.metafacture">Maven Central</a>.</p>
<p>Alternatively, you can simply guess the package names from the top-level folders in the source code repository – they are the same.</p>
<p>For instance, if you want to use the <code>metafacture-io</code> library in your project, simply add the following dependency to your <code>pom.xml</code>:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode xml"><code class="sourceCode xml"><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">&lt;dependency&gt;</span></span>
<span id="cb1-2"><a href="#cb1-2"></a> <span class="kw">&lt;groupId&gt;</span>org.metafacture<span class="kw">&lt;/groupId&gt;</span></span>
<span id="cb1-3"><a href="#cb1-3"></a> <span class="kw">&lt;artifactId&gt;</span>metafacture-io<span class="kw">&lt;/artifactId&gt;</span></span>
<span id="cb1-4"><a href="#cb1-4"></a> <span class="kw">&lt;version&gt;</span>$VERSION<span class="kw">&lt;/version&gt;</span></span>
<span id="cb1-5"><a href="#cb1-5"></a><span class="kw">&lt;/dependency&gt;</span></span></code></pre></div>
<div class="sourceCode" id="cb1"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb1-1" title="1"><span class="kw">&lt;dependency&gt;</span></a>
<a class="sourceLine" id="cb1-2" title="2"> <span class="kw">&lt;groupId&gt;</span>org.metafacture<span class="kw">&lt;/groupId&gt;</span></a>
<a class="sourceLine" id="cb1-3" title="3"> <span class="kw">&lt;artifactId&gt;</span>metafacture-io<span class="kw">&lt;/artifactId&gt;</span></a>
<a class="sourceLine" id="cb1-4" title="4"> <span class="kw">&lt;version&gt;</span>$VERSION<span class="kw">&lt;/version&gt;</span></a>
<a class="sourceLine" id="cb1-5" title="5"><span class="kw">&lt;/dependency&gt;</span></a></code></pre></div>
<p>or if Gradle is your build tool of choice use:</p>
<pre class="groovy"><code>dependencies {
implementation &#39;org.metafacture:metafacture-io:$VERSION&#39;
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://metafacture.github.io/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
Loading