mirror of
https://github.com/seigler/dash-docs
synced 2025-07-28 10:16:15 +00:00
2718222c9b
implement multilanguage new improved clients list page update history and statistics in the "about" page add "Some things you need to know" page add "Support Bitcoin" page add a contextual presentation for each category of users (individuals, organizations, developers and enthusiasts) add a short and concise "how it works" page add a "vocabulary" page for Bitcoin technical words definitions give more visibility for the foundation new website design and layout
87 lines
2.7 KiB
Markdown
87 lines
2.7 KiB
Markdown
# Requirements
|
|
|
|
Installing dependencies
|
|
|
|
sudo apt-get install rubygems ruby1.9.1-dev build-essential
|
|
sudo gem install jekyll aquarium json less therubyracer
|
|
|
|
# Usage
|
|
|
|
* update DOWNLOAD\_VERSION in _config.yml
|
|
* run ./_contrib/updatesitemap if you changed a page
|
|
* run jekyll
|
|
* output will be in \_site/
|
|
|
|
# Translation
|
|
|
|
* Find the two letter ISO 639-1 code for your language (fr, en, jp)
|
|
* Run ./_contrib/translate (language code) (language name)
|
|
* Make sure that languages are listed in alphabetical order in _config.yml
|
|
* Rename html files in (lang)/ according to your language. And update links in _layouts/base-(lang).html and (lang)/*.html to reflect your changes.
|
|
* Translate all .html and images files in (lang)/ and _layouts/base-(lang).html
|
|
* A tips for translators, you can preview your work in a simple Google chrome browser with no HTTP server. Just go to the existing english page, open the javascript console with CTRL + SHIFT + J and use the following command to make the page editable : document.body.contentEditable=true
|
|
|
|
## Advanced Usage
|
|
|
|
### Alerts
|
|
|
|
You can easily put a global alert on the website by changing the ALERT and ALERT\_CLASS variables in _config.yml.
|
|
And you can also set an alert specific to a language by appending the language code to the ALERT.
|
|
|
|
Example:
|
|
|
|
```
|
|
ALERT_CLASS: error
|
|
ALERT: <strong>Security alert:</strong> Please upgrade to 0.3.25 as soon as possible!
|
|
ALERT_fr: <strong>Alerte de sécurité:</strong> Mettez Bitcoin à jour vers la version 0.3.25 sans délais!
|
|
```
|
|
|
|
will produce an english red alert box for all languages, and a translated red alert box for french language.
|
|
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
|
|
* `category: ...` 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
|
|
* aquarium
|
|
* json
|
|
* less
|
|
* therubyracer
|
|
|