bitcoincore.org

This repository is the source code of the Bitcoin Core project website built with Jekyll.

Directory structure

File names must be in the format Y-m-d-title.md, e.g. 2015-12-31-title.md. File names can be translated.

The main translations can be found at Transifex. Please join if you wish to contribute to translating content.

Menu and miscellaneous localisations can be found in:

The following Front Matter is required for the multilingual setup in all files. The required fields are as follows:

name: group name for unique article. Each translation must share the same group name, e.g. october15-report
id: each article translation must have a unique ID. Use the language code + -name field. e.g. en-october15-report
permalink: the must include the language code, end a trailing slash, e.g. /en/2015/12/31/report/.
title: the translated title of the article
type: the content type (pages, posts, releases, meetings, etc.)
layout: the layout template (page, post, etc.)
lang: the language code (en, fr, etc.)

---
title: Short Title
name: short-title
layout: post
type: posts
lang: en
id: en-short-title
permalink: /en/2016/01/01/short-title
---

This website is based on Jekyll. To build locally, install Ruby 2.2.2 or greater and then run the following commands:

gem install bundle
bundle install

To preview the site (this will launch a tiny webserver on port 4000):

bundle exec jekyll server --future

To simply build the site (output placed in the _site directory):

bundle exec jekyll build --future

Note that the --future parameter is only required if you're adding any pages dated in the future (such as prepared release announcements).

To test the site:

bundle exec jekyll build --future --drafts --unpublished && bundle exec htmlproof ./_site

The additional parameters to jekyll build ensure that all possible pages are built and checked.

Contributions welcome. Please see CONTRIBUTING.md for details.