joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 01:36:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
114 commits 77 branches 1 tag 51 MiB
Find a file
Daniel Folkinshteyn e4aaec42b5 Main page: link version to the download directory. 
This makes the SHASUMS file discoverable.
It may even be a good idea to link to the SHASUMS directly
in the list of file links,
to encourage integrity checking on the part of the users,
but if we don't want to confuse non-techies, at the very
least we can link to the directory containing all files.
2012-03-29 21:11:05 -04:00
_contrib update_website.sh: cleanup on errors 2011-11-21 15:26:03 +01:00
_includes split content into subpages 2011-09-16 20:39:09 +02:00
_layouts Update copyright dates in the footer, add a summary to the top of feb20. 2012-02-18 22:37:15 -05:00
_less make topbar static 2011-09-16 20:58:00 +02:00
_plugins update README (use ruby lessc instead of node.js) 2011-09-16 19:52:43 +02:00
_posts April -> March 2012-03-16 20:50:26 -04:00
img Added gravatar default image 2011-11-30 16:22:08 +00:00
lib get rid of javascript (unreliable) 2011-09-16 20:52:42 +02:00
.gitignore initial commit 2011-08-31 21:30:26 +02:00
_config.yml split content into subpages 2011-09-16 20:39:09 +02:00
about.html img tags use src=, not href= 2011-11-30 16:33:08 +00:00
bitcoin.pdf initial commit 2011-08-31 21:30:26 +02:00
CNAME re-add CNAME with bitcoin.org 2011-09-03 17:41:56 +02:00
critfix.html Swedish translation. 2012-03-17 12:15:03 -04:00
favicon.ico initial commit 2011-08-31 21:30:26 +02:00
feb20.html Post-transition update to feb20.html. 2012-02-19 19:11:16 -05:00
gavinandresen.asc Updated keys (BE38D3A8 and 1FC730C1) for Gavin-- new 4096-bit RSA key, and both keys signed by several people. 2011-12-15 17:35:45 -05:00
gmaxwell.asc Adding myself to the index. Also a minor update to the feb20.html 2012-02-19 13:58:24 -05:00
index.html Main page: link version to the download directory. 2012-03-29 21:11:05 -04:00
jgarzik-exmulti.asc initial commit 2011-08-31 21:30:26 +02:00
laanwj.asc add Wladimir to list of developers 2011-10-19 15:59:15 +02:00
news.html news section 2011-09-03 11:08:23 +02:00
pieterwuille.asc Updated my gpg key 2012-03-16 17:42:06 +01:00
README.md README: update dependencies 2011-11-21 15:18:06 +01:00
schneider.asc add press-list, renamed all PGP keys to .asc 2011-09-03 14:18:53 +02:00

README.md

Requirements

Installing dependencies

aptitude install rubygems
gem install jekyll aquarium json less

Usage

  • update DOWNLOAD_VERSION in index.html
  • run jekyll
  • output will be in _site/

Advanced Usage

Alerts

You can easily put alerts on the homepage by changing the ALERT and ALERT_CLASS variables in index.html.

Example:

ALERT_CLASS: error
ALERT: <strong>Security alert:</strong> Please upgrade to 0.3.25 as soon as possible!

will produce a red alert box. Possible classes are: error (red), info (blue), success (green) and warning (yellow)

Release Notes

Release notes should be placed in _posts/releases/YEAR-MONTH-DAY-SHORTTITLE.md and adhere to this format:

---
layout: post
title: Bitcoin version 0.3.24 released
src: http://sourceforge.net/mailarchive/message.php?msg_id=27771039
category: releases
---

Bitcoin v0.3.24 is now available for download at
<https://sourceforge.net/projects/bitcoin/files/Bitcoin/bitcoin-0.3.24/>

...
  • SHORTTITLE is used to construct the URL. Something like v0.3.24 will be fine
  • layout: post important for Jekyll
  • title: ... will be used as the title
  • src: ... (optional) link to full annoucement
  • categorry: ... category of post ** releases ** events

Aliases for contributors

Aliases for contributors are defined in _config.yml.

aliases:
  s_nakamoto: Satoshi Nakamoto
  --author=Satoshi Nakamoto: Satoshi Nakamoto
  gavinandresen: Gavin Andresen

Requirements

These ruby gems are required to build the website:

  • jekyll
  • json
  • aquarium
  • less