mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 09:46:12 +00:00
update README.md with information about news section
This commit is contained in:
parent
797b3d4fb2
commit
24b777b163
1 changed files with 22 additions and 0 deletions
22
README.md
22
README.md
|
@ -23,3 +23,25 @@ ALERT: <strong>Security alert:</strong> Please upgrade to 0.3.25 as soon as poss
|
||||||
|
|
||||||
|
|
||||||
will produce a red alert box. Possible classes are: error (red), info (blue), success (green) and warning (yellow)
|
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
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue