Improvements:
- Page titles can now use metaExtra information, which was only available to the page body previously.
- README updated with more information.
- patch: Add Flowzone [Vipul Gupta (@vipulgupta2048)]
- Change console.err to console.error [zoobot]
- patch: Exit the process when error is detected [Vipul Gupta]
- Rename to @balena/doxx [Pagan Gazzard]
Update dependencies [Pagan Gazzard]
- Add .versionbot/CHANGELOG.yml for nested changelogs [Pagan Gazzard]
- Build coffeescript files before publishing [Pagan Gazzard]
- Add .version/CHANGELOG.yml for nested changelogs [Pagan Gazzard]
- Build coffeescript files before publishing [Pagan Gazzard]
- Tests: Specify this repo has no tests [Gareth Davies]
- Meta: Add support to expand variables in excerpt [Gareth Davies]
- Dependencies: bump metalsmith-markdown version to latest to resolve issue where generated anchor links are invalid. [Chris Crocker-White]
- Dependencies: Add missing metalsmith import [Dimitrios Lytras]
- Continue support for subpaths This is with reference to the dynamic pages dropdown switch generator using data-url-template attributes to pass URLs to client JS. [Chris Crocker-White]
- Add support for subpaths [John (Jack) Brown]
Improvements:
- new custom Handlebars block helpers for working with semver:
semverGt
,semverGte
,semverLt
,semverLte
,semverEq
,semverNeq
,semverSatisfies
,semverCmp
. The arguments match those of the corresponding methods in semver module.
Bugfix: fail loud on unknown variables in navigation URLs, instead of going into infinite recursion.
Examples converted from CoffeeScript to plain JS
Bugfixes: safe handling of edge cases and orphan pages
Breaking:
-
navigation
swig
helpers unified and simplified a lot:isCurrentPage
->navIsCurrentPage(navNode, $nav)
isCurrentTree
->navIsCurrentTree(navNode, $nav)
getLink
->navGetLink(navNode, $nav)
getTitle
->navGetTitle(navNode, $nav)
(
$nav
is a new context variable described below) -
context variables renamed:
selfLink
->$nav.url
navPath
->$nav.path
Improvements:
A new $nav
variable is defined with the following properties:
url
— the link to this page (in form of/ref
)path
— the navigation path (an object where keys are page IDs and values aretrue
)title
— the "navigation" title for this page, either a populated dynamic title, or the regular title as defined in navigation
Added support for rich collection of helpers
Move some utility functions to doxx-utils
Fix wrong minimal metalsmith-dynamic version
Breaking:
- files with duplicate refs (basically name without extension) can cause navigation glitches. This is a bit of edge case, because normally all files should use the same extension like
.md
Improvements:
$partials_search
(if specified) now does not have to specify_default
in the end — it's always assumed automatically.Handlebars
andswig
engines are now exposed as static properties ofDoxx
. Can be used to register additional helpers and filters.- update dependencies
Breaking:
- using partials in non-dynamic pages will now print warnings (and import
prefix/_default
). It used to thrown an error before.
Updated GitHub repository
Breaking:
$originalRef
is now more consistently$original_ref
dynamic_page
is nowdynamic
dynamic_page.partials_search
is nowdynamic.$partials_search
dynamic_page.switch_text
is nowdynamic.$switch_text
Improvements:
- improved default search order generation
Breaking:
dynamic_page.url
is nowdynamic_page.ref
$baseUrl
variable is now$originalRef
(used inref
prop)$url_template
is now$ref_template
and doesn't have the leading slash
Breaking:
- Axes renamed to Variables
$variable
->$variable_id
,$variable_details
->$variable
Improvements:
partials_search
is now optional and will be autogenerated if skipped
- Initial release