- Optionally apply tidy to markup (attempted, not working well in OSX)
- Add a syntax highlighter to sample tags, fallback to GFM code blocks
- Check/fix paths in Windows
- the html templates are not that appealing... does anyone wanna help?
- single-page template need full rewrite OR migrating most logic from multi-page which has since improved!
- handlebars whitespace handling, which is very ineffective (logic tags generating \ns and stuff, particularly painful when generating markdown!)
- added support for glob syntax (like
.gitignore
or grunt) to the sourceFiles option. Thanks mariomc and the guy who made simple-glob module.
- improved
multi-page
template to match most ofmarkdown
's functionality (function signatures and order of type, parameters, description)
- improved
markdown
templates for functions A LOT (hard to do with all the whitespace constraints!) - added a small inkdoc promoting message in the generated doc footer's main page, can be opted out via configuration (
skipInkdocPromotion
)
- fixed bug in multi-page template's feature
- now the module tag can be invoked several times (there was a bug which was losing info and generating duplicates)
- generated files use the extension of the
markupFile
option - created
markdown-multi-page
template - fixed some bugs on
markdown-multi-page
andmulti-page
templates (should apply them to other ones too)
- first round at the
multi-page
template. it's mostly a hack for now.
- refactored generateMarkup into generateMarkup and prepareStructure
- changed the signatures of all methods, therefore 0.2.0...
- support for multi-file output via custom file handlebars helper
- files in a template directory which have an extension other than .hbs get copied to the output dir
- added debug option
- now using semver versioning
- added markdown template, more suited for github repos and stuff
- extracts identifiers optionally
- exposing new options identifiersFile, skipIdentifiers
- metadata format now uses arrays as bags instead of objects (simplifies template scripting without any drawbacks)
- added tag
namespace
(similar to a class, but a bag of stuff without need to call new Ctor()) - added option
sortChildren
, true by default
- now the type is unwrapped from {}
- added CSS class for boolean tags (named tag)
- major rewrite of README.md
- changed the option files to sourceFiles (to avoid confusion)
- passed options to generateMarkup
module
tags become optional
- global executable (inkdoc)
- support for .inkdocrc
- ditched old comment extraction code in favor of esprima
- completely rewritten tag parsing strategy (from top-down to bottom-up)
- friendly warnings and errors
- added several tags
- slightly improved template
- added aliases for tags
- added tags attribute/variable/property
- functions/methods can be assigned to modules directly
- attributes are now supported
- fixed double attribution of property tags
- error messages are now more verbose (featuring the source file and line)