The script must be in src/jbake/assets/script/category where category is one of the availables. Currently we have
basico
,bbdd
,docker
,file
,google
,office
, etc ( basico it’s basic in spanish )
The asciidoct must be in src/jbake/content/category (be aware of the directory)
As a general rule we capitalize the script but not the adoc. If you write a post in english it’s better to add the -en
suffix to the name (i.e. my-documentation-en.adoc )
The adoc file needs to have this header:
= Title
Name <email@email.domain>
yyyy-mm-dd
:jbake-type: post
:jbake-status: published
:jbake-tags: blog, asciidoc, all the tags you want
:jbake-category: the category
:jbake-script: /scripts/categoria/NombreScript.groovy
:jbake-lang: en (if it's in english, or empty if it's in spanish)
:idprefix:
:imagesdir: ../images
You documentation starts here
jbake-category
is the attribute that helps the generator position your script in the menu
jbake-script
is the attribute that helps the generator link your script with the documentation
jbake-lang
is the attribute that indicates on which language your documentation is
`jbake-type`indicates that it is a post type document (the one we use)
`jbake-status`indicates the document is ready for publication (otherwise please use draft)