Your Own Embassy Website - Appsterdam/open GitHub Wiki

If you run one of the Appsterdam Embassies, you can use the Appsterdam Embassy Page Project as the base of your website.

Creating Your Website

In order to create your website you can fork the repository to your own Appsterdam Embassy Organization Page.

If you do not yet have a organization page for your Embassy you can learn more about setting up on this help page.

Getting Ready For Launch

After you have forked the repository, you can go to the settings of the repo and rename the repo.

You should follow the following convention: YourOrganizatioName.github.io

This will ensure that GitHub will pick up on your page and will generate the site for you.

After a short while your page should be available on http://YourOrganizatioName.github.io.

Configure the site

In the repo you will find a file named _config.yml. It should look something like this:

name: Appsterdam Embassy Page
markdown: redcarpet
pygments: true
paginate: 5
paginate_path: "pages/page:num"
timezone: Europe/Amsterdam
exclude: [LICENCE, README.md]
permalink: pages/:title/
embassy:
  name: Appsterdam Embassy Name
  url: http://embassy.appsterdam.rs
  location: Amsterdam
  email: [email protected]
  social:
    twitter:
      handle: "@Appsterdam"
      url: http://www.twitter.com/appsterdam
    github:
      handle: Appsterdam
      url: https://www.github.com/appsterdam/open
    facebook: http://www.facebook.com/appsterdam
    linkedin: http://www.linkedin.com/groups/Appsterdam-3920468
    flickr: http://www.flickr.com/groups/1723974@N21
    youtube: http://www.youtube.com/appsterdam

You can change all the settings to reflect your local embassy.

Remix and Remaster

As you will notice, the site is very basic and is in the style of the main Appsterdam website.

Feel free to remix, add, remove enhance and improve on what is there.

If you leave it 'as-is' you will have the following features:

• Home page
  • The Appsterdam Mission Statement
  • The last 5 articles
• Contact Page
  • Basic Info
  • Organizers of the Embassy
  • The details of the Appsterdam Foundation
• Links to your social media

Note that the listing of the organizers is done by retrieving the publized owners of the GitHub organization. So be sure to add your crew to the project so they will have the proper mentioning on the page.

Rolling Your Own

If you decide to roll your own website, go right ahead. But we do appreciate it if you fork the repo and use it to host your website code in.

This will allow us to keep track of all the embassies and the websites they run.

Under the Hood

GitHub Pages are run via Jekkyl. Jekkyl generates static websites from a collection of HTML and Markdown files.

Every time you push to the master branch of your embassy page repo, GitHub will regenerate your site.

Articles

In the repo you will find a folder named _posts. In this folder you can add Markdown files prefixed with a date like this YYYY-MM-DD-your-article-title.md

When you save the new page and push it to the master branch (or add it via the GitHub editor on the website) the article will be added to the site.

It will show on the homepage and it will also have it's own unique link.

Contribute

If you want to contribute to the website, fork the repo, make changes and open a pull request.