dash-docs/en/bitcoin-core/index.md
David A. Harding 7d98f798ab
Upgrade to Jekyll 3.0
Gemfile:

  - Upgrade to Jekyll 3.x (3.0.1 tested).  This brings several new
    features I want to use, most notably *collections* which allows us
    to add blog-like collections. I've converted the `_releases` and
    `_alerts` pages into collections, although their plugins are
    maintained to handle the Download and Active Alert features.

  - Upgrade to latest Kramdown.

  - Lock Less at 2.4.0.  This prevents breaking our Less plugin.  Jekyll
    3.x provides native support for SCSS, so we may want to switch to
    that in time.

  - Lock HTML Proofer at 2.1.0.  The most recent version was taking
    forever to check our pages (I never actually got it to complete).
    I'll look into it when I get more time.

Makefile:

  - New `make clean` command.  Jekyll 3.x by default attempts to do
    incremental rebuilds.  The new `jekyll clean` command cleans up the
    metadata necessary for than so that a full build is performed, and
    this new `make clean` command is a wrapper around it so that we
    automatically do full rebuilds in the relevant cases.  Note: our
    plugins aren't fully compatible with the incremental rebuilds, but
    I'd like to fix that in the future.

  - Remove WEBrick hack to enable previewing with default URL paths (/
    instead of /index.html).

  - Filter out compliants from Rouge

README.md:

  - Now that Alerts (_alerts) are part of a collection, the file names
    are no longer parsed for dates, so instructions on adding the date
    to the YAML metadata have been added.

_alerts/*:

  - Now that alerts are part of a collection, the file names are no
    longer parsed to provide dates, so a `date:` field has been added to
    the YAML metadata.

_config.yml:

  - Some variables renamed per upgrade instructions.

  - Switched from old default syntax highlighter Pygments to new default
    Rouge.  I tried to use Rouge options to keep new output as similar
    to old output as possible to making diffing easy, but Rouge adds
    extra CSS class info.

  - Move `_alerts` and `_releases` into Jekyll 3.x "collections", which
    provide the organizational features we were using plugins to
    manange.  I haven't removed the old plugins because we still use
    some of their features (alerts.rb provides active issue and banner
    features; releases.rb provides info to Download page)

  - _layouts/* can no longer provide default global metadata; that is now
    provided in the new `defaults:` section in _config.yml.

_layouts/*:

  - Default metadata can no longer be provided in the layout files for
    collections, so I've removed it and left a message to see
    _config.yml.

_plugins/*:

  - Remove filter_for.rb. It's completely broken on Jekyll 3.x because
    of changes to Liquid which prevent adding new arguments to the
    inherited Liquid::For class. Existing uses of filter_for have been
    migrated to built-in for loops prefaced by sorts.

  - Remove remove-html-extension.rb: at it said in the comments, this
    was a temporary hack to get us to Jekyll 3.0.

_releases/*:

  - Rename all the files: prefix a v to the file name so the output html
    (e.g. v10.0.0.html) is the same as the source filename (e.g.
    v10.0.0.md).  This is necessary to migrate them to a Jekyll collection.

  - Remove %v from titles: we have to explicitly set the title, like we
    used to.  Again required for migration to collections.

_templates/events.html & en/rss/events.rss:

  - Sort events by date and then loop with regular for loop rather than
    filter_for

en/alerts.html & en/rss/alerts.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for

en/bitcoin-core/index.md & en/version-history.html & en/rss/releases.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for
2016-01-06 23:09:56 -05:00

117 lines
3.8 KiB
Markdown

---
# This file is licensed under the MIT License (MIT) available on
# http://opensource.org/licenses/MIT.
layout: base-core
id: bitcoin-core-overview
columns: 1
lang: en
title: Bitcoin Core
breadcrumbs:
- bitcoin
- Bitcoin Core
---
{% assign date_sorted_releases = site.releases | sort: 'optional_date', 'last' %}
<link rel="alternate" type="application/rss+xml" href="/en/rss/releases.rss" title="Bitcoin Core releases">
# Bitcoin Core
{:.not-displayed}
![Bitcoin Core: Helping You Keep Bitcoin Decentralized](/img/bitcoin-core/en-big-logo.svg)
<br class="clear">
{% include bitcoin-core/download-bitcoin-core.html %}
<br class="clear">
<div class="show_less_more">
<div class="show_less" markdown="block">
Bitcoin Core is programmed to decide which block chain contains
valid transactions. The users of Bitcoin Core only accept
transactions for that block chain, making it the Bitcoin block
chain that everyone else wants to use
</div>
<div class="show_more" markdown="block">
It is these users who <b>keep Bitcoin decentralized.</b> They
individually run their own Bitcoin Core full nodes, and each of
those full nodes separately follows the exact same rules to decide
which block chain is valid.
There's no voting or other corruptible process involved: there's
just individual software following identical rules—"math"—to
evaluate identical blocks and coming to identical conclusions
about which block chain is valid.
This shared agreement (called consensus) allows people like you to
only accept valid bitcoins, <b>enforcing Bitcoin's rules</b> against
even the most powerful miners.
In addition to improving Bitcoin's decentralization, Bitcoin Core users get
[better security][bcc validation]
for their bitcoins,
[privacy features][bcc privacy]
not available in other wallets, a choice of
[user interfaces][bcc user interface]
and several other powerful features.
</div>
<p class="center"><button class="toggle_show_more_less js not-displayed"><span class="fa fa-caret-down"></span> Read more</button></p>
</div>
<br>
<div markdown="block" class="two-column-list">
{:.fa-ul}
- <span class="fa-li fa fa-download fa-2x"></span>
<b>[Download][bcc download]</b><br
>Download Bitcoin Core&nbsp;{{ site.DOWNLOAD_VERSION }}
- <span class="fa-li fa fa-rocket fa-2x"></span>
<b>[Features][bcc features]</b><br
>Discover what Bitcoin Core offers
- <span class="fa-li fa fa-question fa-2x"></span>
<b>[Get help][bcc help]</b><br
>Documentation, forums, chat rooms
- <span class="fa-li fa fa-code-fork fa-2x"></span>
<b>[Contribute][bcc contribute]</b><br
>Code, translations, and more
</div>
<br class="clear">
### News
{% comment %}<!-- Capture all the releases into a string and convert it to an array -->{% endcomment %}
{% capture text_releases %}
{% for p in date_sorted_releases reversed %}
{% if p.optional_date %}{{ p.optional_date | date:"%Y-%m-%d" }} - {% endif %}<a href="{{ p.url | replace:'.html','' }}">{{ p.title }}</a>::
{% endfor %}
{% endcapture %}
{% assign array_releases = text_releases | strip_newlines | split: '::' %}
- 2015-12-21 - Capacity increases for the Bitcoin system: [Statement](/en/bitcoin-core/capacity-increases) & [FAQ](/en/bitcoin-core/capacity-increases-faq)
{% comment %}<!-- show the latest three releases -->{% endcomment %}
{% for release in array_releases %}
{% if forloop.index <= 3 %}
- {{ release }}
{% endif %}
{% endfor %}
For more news, see the complete list of [Bitcoin Core releases][bcc
version history]. For notifications of new releases, <a
type="application/rss+xml" href="/en/rss/releases.rss">subscribe to the
RSS feed</a>.
<br class="clear">
<script>
if ( $( window ).width() > 400 && $( window ).height() > 600 ) {
$(".show_more").removeClass("show_more");
$(".toggle_show_more_less").removeClass("toggle_show_more_less");
}
</script>
{% include references.md %}