diff options
| author |   Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-08 12:39:57 +0100 |
|---|---|---|
| committer | Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-10 14:53:01 +0100 |
| commit | c530e84843444a40804e0c2b038c2ec53fe411b2 (patch) | |
| tree | 1a9eebf49fd85027ba472bad8c178d686bad8d56 /README.md | |
webdocs-agl: added developer website template
Change-Id: I4a45ee0ad5dd0c29a6d6876a0e02cd5550c010e9
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..530d620 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +Introduction +============ + +This repository contains AGL documentation website sources, rendering is visible at http://docs.automotivelinux.org +This website relies on the generator located in doctools/webdocs. + +Installing +========== + +## dependencies: webdoc + +See how to install webdocs: read file in doctools/webdocs/README.md + +## configure webdoc + +Edit conf/AppDefault ++ Default configuration consider that webdoc tools & site are within the same parent directory. ++ If needed, update Doc_TOOLS to the right path. + +## generate a 1st site from your template +``` + ./build --clean # deleted all generated file if any + ./build --fetch [--force] # collect doc from github (fetch list in site/_tocs/*/fetch_files.yml) + ./build --build --serve --watch --incremental # build config/tocs, generate html and start a local webserver + + browser on http://localhost:4000 + + ./build --push --verbose # push generated to production webserver (check conf/AppDefault 1st) +``` + +## start writing documentation + +- the directory ./site holds your website contend +- site/* directories not prefixed with "_" represent en entry within the menu +- site/_* directory contains template, configuration, options +- site/_data is a special directory that hold both static and generated files to adjust page/site values within html pages +- site/_tocs/*/toc_VERSION_LANGUAGE.yml TOC(TableOfContend) and GitFetch definition (ex: appfw) +- site/_layouts holds page template + +- register at https://community.algolia.com/docsearch/ and update your apikey into conf/_config.yml + + +## bugs + +``` + --watch to automatically regenerate pages on markdown file, you should force "./build --configs" when changing TOC or versions. +``` + |