mirrors/eclair
1
0
Fork 0
mirror of https://github.com/ACINQ/eclair.git synced 2025-02-24 14:50:46 +01:00
Code Issues Projects Releases Wiki Activity
eclair/docs
History
Andrea e8914adc39
Update README for building the docs
2019-03-26 11:31:04 +01:00
..
fonts Add initial version of the doc 2019-03-25 17:13:08 +01:00
images Add better logo 2019-03-26 11:00:22 +01:00
javascripts Add initial version of the doc 2019-03-25 17:13:08 +01:00
slate Move curl example parameters 2019-03-25 18:40:42 +01:00
stylesheets Add initial version of the doc 2019-03-25 17:13:08 +01:00
index.html Add initial version of the doc 2019-03-25 17:13:08 +01:00
README.md Update README for building the docs 2019-03-26 11:31:04 +01:00

README.md

Eclair documentation man page

  • How to build

Building

The documentation uses slate and is hosted via github pages in this repo. To get started you need to download slate in your local machine, you need ruby, ruby-bundle and a few other dependencies. For the complete instructions on how to run slate please refer to its official documentation here.

⚠️ On ubuntu 18.10 you have to append gem "therubyracer" to Gemfile ⚠️

Modifying eclair doc

  1. Copy recursively eclair/docs/slate into slate/source and open a text editor at slate/source/index.html.md
  2. Make your changes
  3. From within the slate folder run bundle exec middleman build --clean as specified by the instructions
  4. Copy the content of slate/build into eclair/docs