Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stebrech committed May 28, 2023
1 parent d12b4b9 commit 1573d6a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# Accessible PDF

This is the repository of the website [accessible-pdf.info](https://accessible-pdf.info). The site is built with the React based framework [Gatsby](https://www.gatsbyjs.com/), hosted and deployed with [Github](https://github.com/) and [Netlify](https://www.netlify.com/).
This is the repository of the website [accessible-pdf.info](https://accessible-pdf.info). The site is built with the static site generator [11ty](https://www.11ty.dev/), hosted and deployed with [Github](https://github.com/) and [Netlify](https://www.netlify.com/).

## Install locally

1. Clone this repository to your local machine
2. Navigate to the folder and run `npm install`
3. Run the command `gatsby develop`
2. Navigate to the folder and run `yarn install`
3. Run the command `yarn start`
4. If you’re finished, stop your development server (with `Ctrl + C` on your command line)

## Markdown content

It’s content is written in Markdown, a lightweight markup language. Actually, there are [MDX](https://mdxjs.com/) files that allow JSX within Markdown.

If Markdown is new to you, I recommend [Markdown Guide](https://www.markdownguide.org/), a good reference guide.
It’s content is written in Markdown, a lightweight markup language. If Markdown is new to you, I recommend [Markdown Guide](https://www.markdownguide.org/), a good reference guide.

Besides the usual formatting options with markdown, the following HTML markup is used for formatting infoboxes:

Expand All @@ -26,7 +24,7 @@ Any markdown file needs a bit of essential metadata at the beginning of the docu

```
---
title: name of the post
title: name of the article
author: names of all authors
date: date in ISO 8601
description: A short description. It is usually the same as the lead of the post. This description will be used for SEO.
Expand Down
12 changes: 5 additions & 7 deletions _DE_LiesMich.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# Accessible PDF

Dies ist das Repository der Website [accessible-pdf.info](https://accessible-pdf.info/de). Die Website wurde mit dem React-basierten Framework [Gatsby](https://www.gatsbyjs.com/) erstellt, gehostet und bereitgestellt mit [Github](https://github.com/) und [Netlify](https://www.netlify.com/).
Dies ist das Repository der Website [accessible-pdf.info](https://accessible-pdf.info/de). Die Website wurde mit dem statischen Site Generator [11ty](https://www.11ty.dev/) erstellt, gehostet und bereitgestellt mit [Github](https://github.com/) und [Netlify](https://www.netlify.com/).

## Lokale Installation

1. Klone dieses Repository auf deinen Computer
2. Navigiere in den neuen Ordner und führe `npm install` aus
3. Gib den Befehl `gatsby develop` ein
2. Navigiere in den neuen Ordner und führe `yarn install` aus
3. Gib den Befehl `yarn start` ein
4. Wenn du fertig bist, stoppe den Entwicklungsserver (mit `Ctrl + C` in deiner Kommandozeile)

## Markdown Inhalte

Der Inhalt ist in Markdown geschrieben, einer leichtgewichtigen Auszeichnungssprache. Eigentlich sind es [MDX](https://mdxjs.com/)-Dateien, die JSX innerhalb von Markdown ermöglichen.

Wenn Markdown neu für dich ist, empfehle ich [Markdown Guide](https://www.markdownguide.org/), ein gutes Nachschlagewerk.
Der Inhalt ist in Markdown geschrieben, einer leichtgewichtigen Auszeichnungssprache. Wenn Markdown neu für dich ist, empfehle ich [Markdown Guide](https://www.markdownguide.org/), ein gutes Nachschlagewerk.

Neben den Standard-Formatierungsmöglichkeiten mit Markdown werden folgende HTML-Auszeichnungen für die Formatierung von Infoboxen verwendet:

Expand All @@ -26,7 +24,7 @@ Jede Markdown-Datei benötigt zu Beginn ein paar Metadaten:

```
---
title: Name des Beitrags
title: Name des Artikels
author: Namen aller Autoren
date: Datum nach ISO 8601
description: Eine kurze Beschreibung. Es ist gewöhnlich identisch mit dem Lead des Beitrags. Diese Beschreibung wird für SEO-Zwecken benötigt.
Expand Down

0 comments on commit 1573d6a

Please sign in to comment.