diff --git a/technical/DevBook.md b/technical/DevBook.md index 6a047ba..baf4b19 100644 --- a/technical/DevBook.md +++ b/technical/DevBook.md @@ -2,26 +2,65 @@ layout: default --- -# Contributing to the Developer Handbook +# Contributing to the Handbook -Technical information for contributors interested to work on Developer Handbook. +Some information for people that want to work on this handbook. - +
-## Running locally +## Setup ( Linux ) -To run the Developer Handbook locally, Jekyll, the Ruby static site generator, must be executed on the corresponding folder.\ -On a Debian or Ubuntu GNU/Linux system, Bundler is used : +The handbook uses [Jekyll] to render +markdown files as a static website. +
+ +### Repository + +Clone the repository to your system. + +```sh +git clone https://github.com/FreeCAD/DevelopersHandbook ``` -$ sudo apt install ruby-bundler ruby-dev build-essential -$ bundle install -$ cd path/to/your/local/fork/of/the/devhandbook -$ bundle exec jekyll serve + +And navigate to the repository folder. + +```sh +cd DevelopersHandbook ``` -Open then the link to `127.0.0.1:4000` (or `localhost:4000`) in you web browser. +
+ +### Dependencies + +Install [Ruby] and the build essentials. + +```sh +sudo apt install \ + build-essential \ + ruby-bundler \ + ruby-dev + +bundle install +``` +
+ +## Editing + +While editing the markdown files, run Jekyll. + +```sh +bundle exec jekyll serve +``` + +Open the address shown in your terminal in +your browser - usually it's `127.0.0.1:4000` + + + + - +
- +[Jekyll]: https://jekyllrb.com +[Ruby]: https://www.ruby-lang.org diff --git a/technical/resources/Handbook-Serving-Browser.webp b/technical/resources/Handbook-Serving-Browser.webp new file mode 100644 index 0000000..850faf3 Binary files /dev/null and b/technical/resources/Handbook-Serving-Browser.webp differ diff --git a/technical/resources/Handbook-Serving-Terminal.webp b/technical/resources/Handbook-Serving-Terminal.webp new file mode 100644 index 0000000..d2800dc Binary files /dev/null and b/technical/resources/Handbook-Serving-Terminal.webp differ