Giter Club home page Giter Club logo

dev.codefor.de's Introduction

Code for Germany – Unsere Website

Dieses Repository beinhaltet die neue codefor.de Webseite. Für die Entwicklung wird Hugo, ein Static Site Generator, verwendet. Den aktuellen Stand kann man sich unter der Adresse https://dev.codefor.de/ ansehen.

Um Inhalte hinzuzufügen oder zu ändern ist im Grunde nur ein wenig Ahnung von Markdown benötigt.

Solltest du Hilfe brauchen oder eine Frage haben, mach gerne ein Issue auf oder frag im OKFDE-Slack Channel #codeforde-website-2-0 nach.

Änderungen vorschlagen oder neue Inhalte hinzufügen

  1. Nur wenn noch nicht geschehen: Hugo installieren
  2. Einen neuen Branch erstellen
  3. Eine neue Datei im Verzeichnis content/blog anlegen.
    • Der Dateiname sollte dem Schema JJJJ-MM-TT-irgeneinname.md folgen. (J = Jahr, M = Monat, T=Tag).
    • In der Datei eine so genannte Frontmatter anlegen. Diese startet und endet mit einer Zeile in der nur --- steht. Der Inhalt der Frontmatter aus der Datei content/blog/0001-01-01-mein-neuer-blogpost.md kopieren.
    • Nach der Frontmatter, den Blogpost schreiben. Es sollte Markdown benutzt werden. (Syntax-CheatSheet)
  4. Mindestens ein Bild auswählen.
  5. Idealerweise lokal testen, ob es funktioniert: Im Terminal ins Projektverzeichnis gehen und einfach hugo -D ausführen.
  6. Änderungen committen und in den eigenen Fork pushen
  7. Pull request eröffnen
  8. Fertig!

Gebaut mit Hugo

Hinweise

  • Der Server ist so eingerichtet, dass er die neue Seite automatisch baut, sobald hier etwas gepusht wird. Außer es gibt einen Fehler! Deshalb:
  • Am besten bearbeitet ihr die Seite lokal und testet dann einmal mit hugo -D, ob sie wirklich funktioniert. Sonst verändert sich nämlich nichts online und jemand anderes muss dann euren Fehler ausbügeln.

Die Struktur im Überblick

(mehr dazu auch hier)

.
├── archetypes ------------> content template files
│   ├── default.md
│   └── projekt.md
├── config.yaml
├── content --- ----------> Der komplette Inhalt der Website
│   ├── advent19 ---------> Die Adventskalenderposts 2019
│   │   └── _index.md ----> legt eine Übersichtsseite an
│   ├── blog -------------> die Blogbeiträge
│   │   └── _index.md ----> legt eine Übersichtsseite an
│   └── ueber.md ---------> codefor.de/ueber
├── layouts --------------> templates in html, definieren content-rendering
│   ├── advent19
│   │   └── list.html ----> definiert Adventsübersichtsseite
│   ├── blog
│   │   ├── list.html ----> definiert Blogübersichtsseite
│   │   └── single.html --> definiert einzelnen Blogbeitrag
│   ├── _default
│   │   └── list.html ----> definiert default-Übersichtsseite
│   ├── labs
│   │   ├── list.html ----> definiert Labs-Übersichtsseite
│   │   └── single.html --> definiert einzelne Lab-Seite
│   └── projekte
│       ├── list.html ----> definiert Projekte-Übersichtsseite
│       └── single.html --> definiert einzelne Projekt-Seite
├── public -> Fertige Seite, im .gitignore, also nicht bearbeiten!
├── README.md
├── resources
│   └── _gen
│       ├── assets
│       └── images
├── static
│   ├── advent19 ---------> Bilder für den Adventskalender 2019
│   ├── blog -------------> Bilder für Blogposts
│   ├── img --------------> Bilder für allgemeines Layout
│   └── projects --------->
└── themes
    └── hugo-cfg
        ├── assets
        │   ├── bulma
        │   │   ├── bulma.sass
        │   │   └── sass
        │   │       ├── base
        │   │       ├── components
        │   │       ├── elements
        │   │       ├── grid
        │   │       ├── layout
        │   │       └── utilities
        │   ├── fresh
        │   │   ├── core.scss
        │   │   └── partials
        │   └── style.sass
        ├── layouts
        │   ├── 404.html
        │   ├── _default
        │   │   ├── baseof.html
        │   │   └── single.html
        │   ├── index.html
        │   ├── partials
        │   └── shortcodes
        ├── static
        │   ├── css
        │   ├── fonts
        │   │   ├── fontawesome-webfont.woff2
        │   │   ├── fontello.woff
        │   │   ├── OpenSans-Regular.woff2
        │   │   ├── OpenSans-SemiBold.woff2
        │   │   └── simple-line-icons.ttf
        │   ├── images
        │   │   ├── favicon.png
        │   │   ├── illustrations
        │   │   └── logos
        │   └── js
        └── theme.toml


Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.