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
12 commits 77 branches 1 tag 51 MiB
Find a file
Nils Schneider a299c4e849 remove <h1>News</h1> from index.html; use post.title instead
2011-09-03 11:45:18 +02:00
_layouts cleaner post layout 2011-09-03 11:42:49 +02:00
_posts/releases newsposts: add link to mailing list posts with signatures 2011-09-03 11:21:29 +02:00
img initial commit 2011-08-31 21:30:26 +02:00
lib add margin to #masthead if there is a topbar 2011-09-03 11:40:53 +02:00
.gitignore initial commit 2011-08-31 21:30:26 +02:00
bitcoin.pdf initial commit 2011-08-31 21:30:26 +02:00
favicon.ico initial commit 2011-08-31 21:30:26 +02:00
gavinandresen.txt initial commit 2011-08-31 21:30:26 +02:00
genjix.gpg initial commit 2011-08-31 21:30:26 +02:00
index.html remove <h1>News</h1> from index.html; use post.title instead 2011-09-03 11:45:18 +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.md with information about news section 2011-09-03 11:26:07 +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