Delta Chat Website
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
_includes
_layouts
_posts fix date for delta-xi, thanks @xeniax Nov 18, 2018
assets
ca
de
en
es
fr
it
nb
pl
pt
ru
sq
tools
.gitattributes
.gitignore
404.html Rename 'layout' folder to 'assets/css' to not mess up with '_layouts'. Aug 26, 2017
Gemfile
Gemfile.lock
LICENSE
README.md
_config.yml
_redirects
favicon.ico
feed.xml
google2faa16b6e4ce3d8b.html
index.html

README.md

Delta Chat Website

This repository contains the default website of Delta Chat - feel free to edit any file as you like and send a pull request.

Formatting of blog posts and web pages

In the various source text files that are used for generating the static https://delta.chat website we use Semantic linefeeds to keep "diffs" for changes small. The gist of it is that you put each "phrase" part of a sentence into a single line.

How to create a new blog post

  • In the directory _posts create new file in the form YYYY-MM-DD-title.md eg. by copying an existing file

  • Write your blog post to the file and do not forget to add or modify the title: and author: line atop

  • That's all, the result goes to https://delta.chat/en/blog , the RSS-Feed, Twitter @delta_chat, Friendica and maybe even more.

Testing changes

  • You can create your fork on Github and Github pages; the forked website will then be available at https://<your-username>.github.io/deltachat-pages/

  • Alternatively, install Jekyll on your local machive and execute jekyll serve --destination <path-to-build-dir> in the source directory.

Directory structure

  • /en - Contains the source language files in Markdown. Can be edited directly.

  • /de, /es, fr ... - Contain the translated files; translation is done through .po files that are translated using Transifex, see above. You must not edit translated files directly here but you can add additional files that are unique to the language.

  • /_layouts - This directory contains a default layout template for each language (the layout is referenced in Markdown using layout: name)

  • /assets - Page specific images and files; in general, we use one subdirectory per page or section here.

  • /assets/css - CSS and layout specific images and files here.

Translate the website

You can edit and improve the existing translations with Transifex. To update existing translations from the Transifex server, see the scripts and the documentation in the tools folder.

To add a new language, the followinging steps are required once:

  • create a new layout in /_layouts/default-<lang>.html and make sure that this layout is referenced in the corresponding Transifex entries as layout: default-<lang>

  • create directory /<lang>

  • add the language to tlangs in /tools/t-dance.sh and run ./t-dance.sh pull from the tools-direcory

  • check the language selection in /index.html and in /_includes/footer-languages.html.

Further Hints

  • whereever possible, use Markdown instead of HTML, esp. in the files that should be translated

  • no JavaScript whereever possible, no weird CSS nor other complicated things

  • the layout should be as simple as possible and should always work on small mobile screens as well as on desktops

  • when layouting, do not force a special structure. Header, Content, Footer - done.

  • no complex navigation - Simply link subpages from the main pages

  • no one-page-layout - we also have sites with long text, and we do not want to have separate layouts

  • we do not want a complex navigation, some toplinks, a footer, done.

  • Remember: Form follows function, KISS. The site should be dead-simple.

  • Finally: Have fun :-)

License

Licensed under the GPLv3, see LICENSE file for details.

Copyright © 2017, 2018 Delta Chat contributors