README

   1 This is the repository of the LEDE web pages.
   2
   3 All pages should follow these rules
   4
   5 * written using asciidoc
   6 * changes are verified using aspell
   7 * changes to the rules.txt files are not allowed without a prior vote
   8
   9 Top level pages are located in this directory while the "Documentation"
  10 can be found in the docs/ sub-folder.
  11
  12 The _includes/ folder contains the html structure of the site navbars,
  13 if you add a page please add it in the respective nav bar so that it
  14 becomes reachable.
  15
  16 The website is generated from asciidoc using jekyll invoked by a cron script
  17 every 15 minutes.
  18
  19 If sources are updated to require new jekyll plugins or a changed configuration
  20 then tell someone with access to the web server so that the settings can be
  21 synchronized with those in the tree.
  22
  23 In order to generate the pages locally for testing your changes,
  24 install https://jekyllrb.com/, issue "jekyll serve" and navigate to
  25 http://127.0.0.1:4000/ with your browser.
  26
  27 LICENSE is TBD and should be placed in the LICENSE file once decided.
  28