Docs

Doc tags

The examples have xml document tags that serve as place holders for beginning and ending of various sections. These sections are parsed out using the doc tool and a markdown file is generated. The markdown file is is then processed by the static site generator ( Jekyll ) to generate the docs using an html theme

Example

//<doc:import_required>
import slatekit.common.args.Args
import slatekit.common.args.ArgsSchema
//</doc:import_required>

//<doc:import_examples>
import slatekit.core.cmds.Cmd
import slatekit.common.Result
import slatekit.common.results.ResultFuncs.ok
//</doc:import_examples>

// more ...

Steps

step	url	notes
Add to examples	slatekit.examples	setup the doc tags

Setup the doc tags Update Doc tools in slatekit.tools to include the new example Generate docs Add links to new component on site Get icon