X-Git-Url: http://git.openwrt.org/?a=blobdiff_plain;f=README;h=1b8a9c79e0e31591be78cb46056c04b8fcaee84e;hb=e2c2bec8429d3acb891b7a4129aa42ea1fb1f23c;hp=8c2e09d40f9f55b656fdfdf0c5912bb52434117f;hpb=c53e1e4c394d6f2ecb711b14530e7189d631ea1f;p=web.git diff --git a/README b/README index 8c2e09d..1b8a9c7 100644 --- a/README +++ b/README @@ -9,6 +9,10 @@ All pages should follow these rules Top level pages are located in this directory while the "Documentation" can be found in the docs/ sub-folder. +The _includes/ folder contains the html structure of the site navbars, +if you add a page please add it in the respective nav bar so that it +becomes reachable. + The website is generated from asciidoc using jekyll invoked by a cron script every 15 minutes. @@ -16,5 +20,9 @@ If sources are updated to require new jekyll plugins or a changed configuration then tell someone with access to the web server so that the settings can be synchronized with those in the tree. +In order to generate the pages locally for testing your changes, +install https://jekyllrb.com/, issue "jekyll serve" and navigate to +http://127.0.0.1:4000/ with your browser. + LICENSE is TBD and should be placed in the LICENSE file once decided.