mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 09:46:12 +00:00
71 lines
1.5 KiB
Markdown
71 lines
1.5 KiB
Markdown
# Requirements
|
|
|
|
Requires [Jekyll](https://github.com/mojombo/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
|
|
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
|
|
|