@ulu/sassdoc-to-markdown
Version:
A flexible SCSS documentation tool that generates clean, customizable Markdown from your Sass stylesheets. It leverages SassDoc for data extraction and offers various configuration options to tailor the output to your specific needs
38 lines (22 loc) • 1.66 kB
Markdown
# Change Log
## 0.0.16
- Add options for "byTypeOrder" which will allow adjusting the order of the sections when outputting "byType", also if a section type is not in the array it will be excluded (not output)
## 0.0.15
- Add options for (hidePrivate, hidePrivateKeepGroup). See Readme for details
## 0.0.14
- Fill in missing info about options in README, and in defaults module (update comments)
## 0.0.13
- Update readme with configuration options
## 0.0.12
- Fix content blocks (add notes to lib/defaults.js on settings), add tests for this
- Add HTML preview like the vitepress version (just outputted as-is), add configuration for this, add tests for this
## 0.0.11
- Add variable name to codeblock output and semicolon wehn a variable is printed in _code annotations (so it doesn't break syntax highlighting)
## 0.0.9
- Add escape method for things being recognized as attributes in markdown (markdown-it-attrs) (ie. 'this error is missing #{ $var }') which aren't actually markdown attributes but sass at the end of a line
- Only added to the following annotations: thow, description, todo (for now)
## 0.0.8
- Fix wrapping in _code custom annotation in "{}", which is for css/placeholder. With that you can choose what to include (config.showSourceCode)
- Now only css and placeholder type are wrapped for code block outputs
- Add type "variable" to defaults showSourceCode, I feel like if you are documenting a specific variable it would seem likely you want to show it's default value. Especially for maps (rather than documenting simple maps)
- This can be configured by setting showSourceCode to ["css", "placeholder"] instead.