diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 3 insertions, 15 deletions
@@ -20,7 +20,7 @@ Other configuration files in conf/ starting by an underscore (_) are used by Jek ## generate a 1st site from your template ``` ../doctools/webdocs/docbuild --clean # deleted all generated file if any - ../doctools/webdocs/docbuild --fetch [--force] # collect doc from github (fetch list in site/_tocs/*/fetch_files.yml) + ../doctools/webdocs/docbuild --fetch [--force] # collect doc from github (fetch list in contain/toc/*/fetch_files.yml) ../doctools/webdocs/docbuild --build --serve --watch --incremental # build config/tocs, generate html and start a local webserver xdg-open http://localhost:4000 @@ -31,6 +31,7 @@ Other configuration files in conf/ starting by an underscore (_) are used by Jek Alternatively, a Makefile can be used and defines the most common operations: ``` make fetch + make localFetch make build make push make serve @@ -43,25 +44,12 @@ Alternatively, a Makefile can be used and defines the most common operations: - site/* directories not prefixed with "_" represent en entry within the menu - site/_* directories contain template, configuration, options used by Jekyll - 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(TableOfContent) and Fetch definitions +- contain/toc/*/toc_VERSION_LANGUAGE.yml TOC(TableOfContent) and Fetch definitions - site/_layouts and site/_includes holds page template - site/static holds assets (static images, CSS etc.) - register at https://community.algolia.com/docsearch/ and update your apikey into conf/_config.yml -## trick - -- For the moment you can only build source documentation from github (automotive-grade-linux/docs-agl). -So if you want to test localy your modification before a "pull request", just change github path with: - -``` -export MY_GITHUB_ACCOUNT=XXX -find ../ -name fetched_files.yml -exec sed -i "s@automotive-grade-linux/docs-agl@$MY_GITHUB_ACCOUNT/docs-agl@g" {} \; -make clean; -make fetch; -make build; -make serve; -``` ## bugs |