Skip to content

Latest commit

 

History

History
212 lines (146 loc) · 6.45 KB

README.md

File metadata and controls

212 lines (146 loc) · 6.45 KB
Raw

arc42.de Website

Live site is hosted by netlify.

Status

Netlify Status

Uptime stats by UptimeRobot.

GitHub open issues GitHub closed issues Github issues total

How does it work?

General

The site is build and created with Jekyll and Markdown. It uses the MinimalMistakes template, with a few slight modifications

  • home.md is the homepage, it's mapped (via permalink) to "/".

Local development

Prequisite: Local build uses a Docker container. You therefore have to have Docker installed.

  1. checkout the repo
  2. run docker compose up

It will start a local jekyll and will serve the generated content on 0.0.0.0:4000

Custom css

  • The timeline (in /termine) is based upon w3schools
  • Some buttons are also based upon w3schools definition.

Custom css is located in /assets/css, the required import statement in /assets/css/main.scss

Form support (for "Anmeldung") and Spam protection

We use formspark.io as backend provider for our "Anmeldung".

For spam protection within the form, we use Botpoison, see especially their getting started with HTML article:

1.Import the @botpoison/browser script.
2. Add your public key to the data-botpoison-public-key attribute.
3. The solution will automatically be attached to the submission (as the _botpoison field).

1: Integrate Botpoison script

A botpoison browser script is required for spam-protection in the Anmeldung-Form, see https://documentation.formspark.io/setup/spam-protection.html#botpoison

We make this a page-specific asset (see https://www.instapaper.com/read/1436398846) by adding the following yaml to anmeldung.md:

---
title: "Anmeldung"
layout: single
permalink: /anmeldung

botpoison: nospam

---

And then adding the appropriate import statement in _includes/head/custom.html:

{% if page.botpoison %}
 <!-- 1. Import the @botpoison/browser script -->
<script src="https://unpkg.com/@botpoison/browser"></script>
{% endif %}

2: Add required info to form

  1. Create the Botpoison publik and secret keys, as explained in Botpoison setup guide
  2. In your form's settings, select Botpoison under Spam Protection.
  3. Copy the secret key, paste it into the Botpoison secret key field in the Formspark form configuration
  4. Add the Botpoison public key to the HTML of the form:
<form
      method="POST"
      action="https://submit-form.com/your-form-id"
      data-botpoison-public-key="your-botpoison-public-key"
      target="_blank"
>

In our concrete case, that looks as follows (file _pages/anmeldung.md)

<form action="https://submit-form.com/AIKiYyJP"
      data-botpoison-public-key="pk_8e195655-38ed-4eec-a445-a1e0d68a488d">

3: Formating of Anmeldung-Email

Formating of the email sent from formspark.io to arc42 is done via handlebar configuration within the Formspark.io website.

<div style="text-align: left;">
  <strong>Neue Anmeldung (über arc42):</strong><br>
  {{data.vorname}} {{data.nachname}} ({{data.email}}) hat<br>

<div style="margin: 16px 0;">
  {{#if data.nachnameTN}}
    <h3>{{data.vornameTN}} {{data.nachnameTN}} ({{data.emailTN}})</h3>
  {{else}}
    <h3>sich selbst</h3>
  {{/if}}
  <br>
für den Kurs {{data.kursdatum}} angemeldet.
</div>
<br>
  Rechnungsadresse: <br>
  <div style="margin: 16px 0;">
  {{data.Rechnungsadresse}} <br>
  </div>
 <br>
  Bemerkung:<br>
  <div style="margin: 16px 0;">
   {{data.comment}} 
  </div>
<br>

</div>

Ensure JavaScript is available

As often, StackOverflow had an answer, we combine a <noscript> tag with a <div> and a small JavaScript function:

<body>
<div id="main_body" style="display: none;">
all content - not displayed...
</div>
</body>

Plus a small JavaScript function to enable the content again...

<script type="text/javascript">
document.getElementById("main_body").style.display="block";
</script>

It does NOT work if users disable JavaScript when already on the form...

Credits

Site theme

Thanx to Michael Rose, creator of the Minimal-Mistakes Jekyll Theme, follow him on Twitter.

Icons + Images:

Licenses

arc42 Template

The arc42 template is licensed under a CreativeCommons Sharealike International 4.0 License.

You are free to:

  • Share — copy and redistribute the template in any medium or format
  • Adapt — remix, transform, and build upon the material for any purpose, even commercially.

Website Theme: MIT License (MIT)

Copyright (c) 2016ff Michael Rose

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.