From cec5751b37d879ead719715792786492f85467ae Mon Sep 17 00:00:00 2001 From: Fabian Steeg Date: Wed, 29 Mar 2023 14:46:03 +0200 Subject: [PATCH] Set up 'Getting started' page (#19) --- .github/workflows/generate_html.yml | 4 +- getting-started.html | 57 +++++++++++++++++++++++++++++ getting-started.md | 28 ++++++++++++++ index.html | 2 +- installation.html | 52 -------------------------- installation.md | 7 ---- navigation.html | 2 +- 7 files changed, 89 insertions(+), 63 deletions(-) create mode 100644 getting-started.html create mode 100644 getting-started.md delete mode 100644 installation.html delete mode 100644 installation.md diff --git a/.github/workflows/generate_html.yml b/.github/workflows/generate_html.yml index 2ba81c2..dca366a 100644 --- a/.github/workflows/generate_html.yml +++ b/.github/workflows/generate_html.yml @@ -22,12 +22,12 @@ jobs: uses: docker://pandoc/core:2.9 with: args: > - --output=installation.html + --output=getting-started.html --include-before-body=navigation.html --css=github-pandoc.css --standalone --title-prefix="Metafacture" - installation.md + getting-started.md - name: Generate ide-extensions/index.html uses: docker://pandoc/core:2.9 with: diff --git a/getting-started.html b/getting-started.html new file mode 100644 index 0000000..7fb9eca --- /dev/null +++ b/getting-started.html @@ -0,0 +1,57 @@ + + + + + + + Metafacture – Getting started + + + + + + +Metafacture + +
+ + Home +  |  + Getting started +  |  + Documentation +  |  + IDE Extensions +  |  + Blog +  |  + Playground +    +
+ + + + + +
+
+

Getting started

+
+

Playground

+

The easiest way to get started with Metafacture is the Playground. Take a look at the first example and run it by pressing the “Process” button. Check out the other examples (first button, “Load Examples”) for different input sources, transformations, and output formats.

+

For commands available in the Flux, see the Flux commands documentation.

+

For functions and usage of the Fix, see the Fix functions and cookbook.

+

Command line

+

To use Metafacture as a command-line tool, download the latest metafix-runner from our releases page. Extract the downloaded archive and change into the newly created directory (e.g. cd metafacture-runner-0.4.0). Run a Flux workflow with:

+

$ ./bin/metafix-runner /path/to/your.flux on Unix/Linux/Mac or $ ./bin/metafix-runner.bat /path/to/your.flux on Windows.

+

To get started, you can export a workflow from the Playground (last button, “Export Workflow”).

+

To set up IDE support for editing your Flux and Fix files, see the IDE extensions page.

+

Next steps

+

For a complete introduction to Metafacture in German, check out the latest iteration of our Metafacture Workshop. For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see our documentation collection.

+ + diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..fd46d71 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,28 @@ +--- +title: "Getting started" +header-includes: + +--- + +## Playground + +The easiest way to get started with Metafacture is the Playground. Take a look at the [first example](https://metafacture.org/playground/?flux=PG_DATA%0A%7Cas-lines%0A%7Cdecode-formeta%0A%7Cfix%0A%7Cencode-xml%28rootTag%3D%22collection%22%29%0A%7Cprint%0A%3B&fix=move_field%28_id%2C+id%29%0Amove_field%28a%2C+title%29%0Apaste%28author%2C+b.v%2C+b.n%2C+%27~aus%27%2C+c%29%0Aretain%28id%2C+title%2C+author%29&data=1%7Ba%3A+Faust%2C+b+%7Bn%3A+Goethe%2C+v%3A+JW%7D%2C+c%3A+Weimar%7D%0A2%7Ba%3A+R%C3%A4uber%2C+b+%7Bn%3A+Schiller%2C+v%3A+F%7D%2C+c%3A+Weimar%7D&active-editor=fix) and run it by pressing the "Process" button. Check out the other examples (first button, "Load Examples") for different input sources, transformations, and output formats. + +For commands available in the Flux, see [the Flux commands documentation](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md). + +For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-fix#functions-and-cookbook). + +## Command line + +To use Metafacture as a command-line tool, download the latest metafix-runner from our [releases page](https://github.com/metafacture/metafacture-fix/releases). Extract the downloaded archive and change into the newly created directory (e.g. `cd metafacture-runner-0.4.0`). Run a Flux workflow with: + +`$ ./bin/metafix-runner /path/to/your.flux` on Unix/Linux/Mac or +`$ ./bin/metafix-runner.bat /path/to/your.flux` on Windows. + +To get started, you can export a workflow from the Playground (last button, "Export Workflow"). + +To set up IDE support for editing your Flux and Fix files, see [the IDE extensions page](/ide-extensions/index.html). + +## Next steps + +For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/). For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation). diff --git a/index.html b/index.html index 49076da..7435843 100644 --- a/index.html +++ b/index.html @@ -27,7 +27,7 @@ Home  |  - Installation + Getting started  |  Documentation  |  diff --git a/installation.html b/installation.html deleted file mode 100644 index 29e61bd..0000000 --- a/installation.html +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - Metafacture – Installation manual - - - - - - - -Metafacture - -
- - Home -  |  - Installation -  |  - Documentation -  |  - IDE Extensions -  |  - Blog -  |  - Playground -    -
- - - - - -
-
-

Installation manual

-
-

See the README of how to install Metafacture.

- - diff --git a/installation.md b/installation.md deleted file mode 100644 index fe8a1b2..0000000 --- a/installation.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Installation manual" -header-includes: - ---- - -See the [README](https://github.com/metafacture/metafacture-core#getting-started) of how to install Metafacture. diff --git a/navigation.html b/navigation.html index 340c857..d75464e 100644 --- a/navigation.html +++ b/navigation.html @@ -5,7 +5,7 @@ Home  |  - Installation + Getting started  |  Documentation  |