docs-webtemplate

docs-webtemplate

AGL documentation site templating (jekyll templates)

Download

Introduction

This repository contains AGL documentation website template, rendering is visible at http://docs.automotivelinux.org This website relies on the generator located in docs-tools

TODO: old documentation below. Should be rewritten to match new git repo scheme.

Installing

dependencies: webdoc

See how to install webdocs: read file in doctools/webdocs/README.md

configure webdoc

Some default configuration options can be overridden in the project directory. For this, you can adjust the configuration file conf/AppDefaults.js

Other configuration files in conf/ starting by an underscore (_) are used by Jekyll. Some options may also be adjusted in particular in conf/_config.yml.

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 content/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

 ../doctools/webdocs/docbuild --push --verbose # push generated to production webserver (check conf/AppDefault 1st)

Alternatively, a Makefile can be used and defines the most common operations:

 make fetch
 make localFetch
 make build
 make push
 make serve
 make clean

start writing documentation

  • the directory ./site holds your website content

  • 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

  • content/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

bugs

 --watch to automatically regenerate pages on markdown file, you should force "./build --configs" when changing TOC or versions.
minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog