• Bitcoin Core project website's source code

• Bitcoin Core RPC
• IRC meetings
• static pages
• blog articles
• Bitcoin Core release notes
• Repository tools
• Zurich 2016

• File names format
  • "Y-m-d-title.md"
    • Example: 2015-12-31-title.md

• uses
  • multilingual setup | ALL files
• fields
  • name:
    • group name / UNIQUE article
    • SAME group name / EACH translation
      • Exmaple: october15-report
  • id:
    • TODO: 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:
    • article's translated title
  • type:
    • content type
      • Example: pages, posts, releases, meetings, etc.
  • layout:
    • layout template
      • Example: page, post, etc.
  • lang:
    • language code
      • Example: 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
---

• -- based on -- Jekyll

• TODO: To build locally, install Ruby 3.1.2 using system packages, rvm, rbenv, or another method. Then clone this repository and change directory into it:

  git clone https://github.com/bitcoin-core/bitcoincore.org.git cd bitcoincore.org

Install the bundle utility using the Ruby package manager, gem, and then use bundle to install the rest of the Ruby packages needed to build this site. Note, depending on your system configuration, you may need to run gem as the superuser by putting "sudo" followed by a space before the gem command. You shouldn't need to use sudo with the bundle command.

gem update --system
gem install bundler
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 htmlproofer --check-html --disable-external --url-ignore '/^\/bin/.*/' ./_site

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

• CURRENT website
  • 's theme == old version of Minimal Mistakes theme