Repository files navigation

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

• _posts/<lang>/posts for blog articles.
• _posts/<lang>/pages for static pages.
• _posts/<lang>/releases for Bitcoin Core release notes

File namesmust be in the formatY-m-d-title.md, e.g.2015-12-31-title.md. File names can be translated.

SeeCONTRIBUTING.md for more information.

The followingFront 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: must include the language code and end with 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 Titlename: short-titlelayout: posttype: postslang: enid: en-short-titlepermalink: /en/2016/01/01/short-title---

This website is based onJekyll. To buildlocally,install Ruby 3.1.2 using systempackages,rvm,rbenv, or another method.Then clone this repository and change directory into it:

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

Install thebundle utility using the Ruby package manager,gem, andthen usebundle to install the rest of the Ruby packages needed tobuild this site. Note, depending on your system configuration, you mayneed to rungem as the superuser by putting "sudo" followed by a spacebefore thegem command. You shouldn't need to usesudo with thebundle command.

gem update --systemgem install bundlerbundle 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 anypages dated in the future (such as prepared release announcements).

To test the site:

bundle exec jekyll build --future --drafts --unpublishedbundle exec htmlproofer --check-html --disable-external --url-ignore '/^\/bin/.*/' ./_site

The additional parameters tojekyll build ensure that all possiblepages are built and checked.

Contributions welcome. Please seeCONTRIBUTING.md for details.

The website uses an old version of theMinimal Mistakes theme. Thetheme's website providesdocumentation, including informationaboutconfiguration variables, creatingpages and posts, addingnew Javascript, and more. Note thatcurrent documentation may describe features not available in the oldversion of the theme used by the website.