-
Notifications
You must be signed in to change notification settings - Fork 21
Contributing Projects
Awesome You want to contribute a project! π
If you want to contribute a project, or have to because you took the seminar, you should take the following things in account:
- Text files should be markdown
- Text files need a yaml front matter
- Image files need fixed formats
- You need to follow a fixed folder structure and naming convention
- Spell check the hell out of it
- English please
- Folder names need to be URL save
- If you want a different license then the projects one you need to specify it
- Code should be contributed as sketch and linked instead of pasting it here
You can see the source for an example project here.
All projects go into the folder /projects/ (duh) and need a unique URL save folder name. Your folder structure should be as the following example:
.
βββ assets
βΒ Β βββ images
βΒ Β βΒ Β βββ out.png
βΒ Β βββ pdfs
βΒ Β βββ example.pdf
βββ splash.png
βββ index.md
The main folder only contains three files: index.md, splash.png and thumb.png (the sizes for these are defined in the Images section). You can place additional files in the folder assets. Images go into assets/images/ PDFs go into assets/pdfs/. If you need anything else create a folder in assets that contains other files.
Your whole project should fit into the index.md file. Use simple Markdown [Mβ] to write your text. You can take a look into the basic Markdown rules here.
You can use different headings throughout your index.md. Just remember to not skip headings. Keep your structure logical. The title of your project will be inserted at the top as h1, in Markdown #. Don't add it again. Start at h2 or the Markdown equivalent ##. Don't forget titles are Title Case.
The six heading elements, H1 through H6, denote section headings. Although the order and occurrence of headings is not constrained by the HTML DTD, documents should not skip levels (for example, from H1 to H3), as converting such documents to other representations is often problematic.
w3.org
Your index.md needs a yaml front matter to be parsed. It should contain the following basic informations:
---
authors:
- "Bugs Bunny"
- "Duffy Duck"
- "Elmar Fudd"
authors-url:
- "https://example.com"
- "https://example.com"
- "https://example.com"
layout: project
title: "Rabbit Season vs. Duck Season"
type: project
---You can extend these informations if you need to with yaml syntax. These values can then be accessed within your markdown like this {{my_variable}}. Normally you should not need this.
The layout variable is fixed. Do not change it. All other entries should be changed by you. Titles should be Title Case, the authors and authors-url arrays need to be in the right order. You can check if your yaml syntax is right with yamllint.com .
There are 3 different kinds of images. Splash images, normal images and thumbnails. All images should be PNG 24 images. For each splash or normal image there needs to be a thumbnail!
!Your project at least needs a splash and a thumbnail for it.
| Type | Size in Pixels | Format |
|---|---|---|
| Splash | 800 Γ 450 | PNG |
| Normal | 500 Γ 500 | PNG |
| Thumbnail | 128 Γ 128 | PNG |
A splash image can be used to show large things. For the sake of loading time your splashes should have the size of 800 Γ 450 pixels.
These are for showing things from your project. Make them 500 Γ 500 pixels.
Thumbnails will be used to create overviews of projects and for mobile versions of the page. Make them 128 Γ 128 pixels. Each thumbnail needs to have exactly the same name as the image it is for with the -thumb addition. For example: If you image is named out.png its thumbnail is named out-thumb.png. They also are located directly next to it.
To have a good site you need to spell check your text. It is really embarrassing to have pages with lots of typos. All text are written in English.
To make this work with the world wide world of webs folder and file names need to be URL safe. That means no upper case, no special characters, no German "Umlaute", no white spaces.
You can add code into the page but just short snippets if you want to highlight something special. If you want to add whole sketches please see the guides on contributing sketches in this wiki.
All the code, images, PDFs and texts are under MIT License. If you really need a different license you need to specify it. Don't make it to restrictive. Sharing means β€