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
43 commits 77 branches 1 tag 51 MiB
Find a file
Nils Schneider b70774cee9 use absolute path for logo image
2011-09-16 20:37:12 +02:00
_contrib create empty _site/ in update_website.sh (else lesscss compiling will not work?!) 2011-09-16 20:09:13 +02:00
_includes use absolute path for logo image 2011-09-16 20:37:12 +02:00
_layouts initial framework for subpage navigation 2011-09-16 20:37:12 +02:00
_less update bootstrap 2011-09-16 20:32:45 +02:00
_plugins update README (use ruby lessc instead of node.js) 2011-09-16 19:52:43 +02:00
_posts/releases newsposts: add link to mailing list posts with signatures 2011-09-03 11:21:29 +02:00
img add press-list, renamed all PGP keys to .asc 2011-09-03 14:18:53 +02:00
lib generate css from less using lessc 2011-09-16 19:22:32 +02:00
.gitignore initial commit 2011-08-31 21:30:26 +02:00
_config.yml initial framework for subpage navigation 2011-09-16 20:37:12 +02: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
favicon.ico initial commit 2011-08-31 21:30:26 +02:00
gavinandresen.asc add press-list, renamed all PGP keys to .asc 2011-09-03 14:18:53 +02:00
index.html initial framework for subpage navigation 2011-09-16 20:37:12 +02:00
jgarzik-exmulti.asc initial commit 2011-08-31 21:30:26 +02:00
news.html news section 2011-09-03 11:08:23 +02:00
README.md update README (use ruby lessc instead of node.js) 2011-09-16 19:52:43 +02:00
schneider.asc add press-list, renamed all PGP keys to .asc 2011-09-03 14:18:53 +02:00

README.md

Requirements

Requires Jekyll

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
---

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

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