Skip to content

Mkdocs Essentials Tasker

This is self contained, self descriptive all-in-one drop-in tasker. It can be executed directly ./mkdocs-build-basic.tasks.yml Or using task tool task -t mkdocs-build-basic.tasks.yml

This tasker contains pip dependencies list at vars.deps_pip_mkdocs It also includes documentation in format of mkdocs-simple-plugin for mkdocs tool.

Can be injected to any conda/pip environment

Get the tasker

Download latest version of mkdocs-build-basic.tasks.yml.

Usage

This tasker support standalone-cli and included-tasker modes.

  • for standalone-cli execution command starts with ./mkdocs-build-basic.tasks.yml
  • for included-tasker execution command starts with task mkdocs-builder: when mkdocs-builder is name given to mkdocs-build-basic.tasks.yml in include statement

We will refer here to standalone-cli usage, because included-tasker usage is mostly change execution command prefix accordingly to include statement.

List Available Tasks 

# ### run command: ./mkdocs-build-basic.tasks.yml -l
task: Available tasks for this project:
* build-site:   build markdown sources to html static web site
* install-here: Install Mk docs essential deps in current env
* serve-site:   serve static site with python server
* serve-source: serve docs from markdown sources
You should run those commands within venv you installed mkdocs-essence using ./mkdocs-build-basic.tasks.yml install-here command.

API Settings

Config Entries

API Tasks







silent: yes