chore(deps): update dependency apidoc to v0.55.0#15
Open
renovate[bot] wants to merge 1 commit intomasterfrom
Open
chore(deps): update dependency apidoc to v0.55.0#15renovate[bot] wants to merge 1 commit intomasterfrom
renovate[bot] wants to merge 1 commit intomasterfrom
Conversation
84efa73 to
28e38ec
Compare
28e38ec to
1741e2d
Compare
1741e2d to
1dcb853
Compare
1dcb853 to
7b51c60
Compare
7b51c60 to
a1c2103
Compare
a1c2103 to
28843f0
Compare
28843f0 to
33e8832
Compare
33e8832 to
408deac
Compare
408deac to
869661a
Compare
869661a to
fd134d9
Compare
fd134d9 to
e1f8ee0
Compare
e1f8ee0 to
8aa8b15
Compare
8aa8b15 to
da6d147
Compare
da6d147 to
a96f3ce
Compare
a96f3ce to
738d364
Compare
738d364 to
8608942
Compare
8608942 to
6418012
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.16.1→0.55.0Release Notes
apidoc/apidoc (apidoc)
v0.55.0Compare Source
v0.54.0Compare Source
@apiDefinewhen producing warnings (PR #1305 by Lucas Cimon, fix #1305)v0.53.1Compare Source
v0.53.0Compare Source
v0.52.0Compare Source
v0.51.1Compare Source
v0.51.0Compare Source
v0.50.5Compare Source
v0.50.4Compare Source
FIXED
--single) (fix #1142)v0.50.3Compare Source
FIXED
ENHANCEMENTS
v0.50.2Compare Source
FIXED
ENHANCEMENTS
v0.50.1Compare Source
v0.50.0Compare Source
BREAKING CHANGES
FIXED
Fix sampleUrl config option behavior:
false, no sample block will be generatedtrue, the current page location will be usedNote that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of
trueforsampleUrlto get the same behavior.Fix non working sortFields function (fix #968)
Fix syntax highlighting for markdown parsed text
Fix color in logs was not showing since upgrade to winston 3
Fix newlines being removed in pre tags (fix #809 by @JayBerlin)
Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @esaracco)
Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @esaracco)
Fix apiSampleRequest not working (fix #984 via #1023 by @esaracco)
Fix error with parenthesis in apiGroup (fix #994 via #1022 by @esaracco)
Fix absent diff on different api route (fix #963 via #1030 by @esaracco)
ADDED
ENHANCEMENTS
v0.29.0Compare Source
v0.28.1Compare Source
v0.28.0Compare Source
v0.27.1Compare Source
v0.27.0Compare Source
useHostUrlAsSampleUrl(#930) by Shivam Kumar Jhav0.26.0Compare Source
v0.25.0Compare Source
0.24.0
0.23.0
0.22.1
0.22.0
0.21.0
0.20.1
0.20.0
@rigwild/apidoc-markdownconverter in README (#839)0.19.1
0.19.0
The number of open pull requests in now 0! :D In this release you'll find one bugfix and also some new features/improvements.
Bugfix:
New features:
Enhancements:
0.18.0
This release comes after more than two years without changes to the code. A lot of things were merged and fixed, so it is possible that this changelog is not entirely complete. Refer to the git log if necessary.
Common
CLI
Template
Maintenance
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
Add new @apiDeprecated annotation.
Add new @apiPrivate annotation.
CLI
--private false|trueparameter to export@apiPrivatemarked methods.Parser
@apiPrivate. 530Template
0.16.0
Greatest improvement: Plugin support
apidoc search now in global node modules dir and local
node_modulesfor modules that start withapidoc-plugin-. (local installed plugins have higher priority)View / clone: apidoc-plugin-test
With a plugin you can add features like new parsers (this was possible before only with CLI param) or filters and workers.
Start adding hooks.
Hooks can be used in plugins to extend or transform data.
If you need a hook in apidoc-core please add your hook and provide a pull request.
How to add a hook into apidoc-core view source code
CLI
Parser
apidoc --encoding utf8Template
0.15.1
0.15.0
CLI
Parser
Template
0.14.0
CLI
Parser
:in @apiParam names.Template
0.13.2
0.13.1
0.13.0
Important changes:
CLI
-c).-i).Template
template.forceLanguageinapidoc.jsonto set a fixed language file without auto-detect the browser language.Parser
@apiParam {(CustomType)[http://...link-to-description.html]}0.12.2
CLI
Template
Parser
0.12.1
CLI
Parser
0.12.0
0.11.0
CLI
--parse-languagesfor custom language regex.Parser
.cljfiles.Template
0.10.1
0.10.0
Split apidoc code
apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it).
You can use apidoc without change anything.
apidoc-core (for developers) is the parser and response the api-data.
apidoc-example (for developers) are the test files for the apidoc-spec.
CLI
true / false parameters can now be used, e.g. enable markdown (default)
--markdownor disable--no-markdown.--markdown.Parser
Template
Common
npm run test).0.9.1
Parser
Bugfix: Extend parser regexp to allow inline comment-code (#180)
Bugfix: Slash only path in api triggered error (#159)
Bugfix: Scrollspy offset (#176)
Bugfix: Get package infos from package.json or apidoc.json (#169)
0.9.0
CLI
Template
Add custom order in apidoc.json
Append apiName or apiGroup in the
orderlist:Speed up rendering of subtemplates (#164)
Bugfix: Special char doesn't show in @apiGroup. (#163)
0.8.2
0.8.1
0.8.0
Parameter
Add as replacement for all (now) deprecated define and structure methods:
@apiDefine@apiUseDeprecated:
@apiDefineErrorStructure@apiDefineHeaderStructure@apiDefinePermission@apiDefineStructure@apiDefineSuccessStructureapiErrorTitleapiErrorStructureapiHeaderStructureapiHeaderTitleapiParamTitleapiStructureapiSuccessTitleapiSuccessStructureRemove unneeded methods since success and error response can be grouped:
@apiInfo@apiInfoExample@apiInfoTitleAdd for consistent usage:
@apiHeaderExample@apiParamExampleChange:
@apiPermission, multiple permission usage in a block is allowed now. Permission names must be defined with @apiDefine.Extend:
@apiParamwith size and allowed values.CLI
--debugor--verbose.Parser
Template
jQueryAjaxSetupto apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings).0.7.2
0.7.1
@apiExample {type} Title,@apiSuccessExample,@apiErrorExample.0.7.0
apidoc.json.--parsefor parse only the files and return the parsed data.0.6.5
0.6.4
0.6.3
0.6.2
apiExample,apiErrorExample,apiSuccessExample. (#78)0.6.1
0.6.0
apidoc.jsonconfiguration file for primary configuration overpackage.json. (http://apidocjs.com/#configuration)0.5.2
0.5.1
apidoc.titleinpackage.json.apidoc.urlinpackage.json.0.5.0
Add new Functions:
Remove package.json path
apidocFilename.Change package.json path
apidoc.Add
apidoc.header/apidoc.footer(with custom navigation titles). (http://apidocjs.com/#headerfooter)Remove template basic (easier to maintain), the default template will be re-designed in a future version too.
Update template libraries.
Add test cases.
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
Add support for other comment-style. Now apiDoc supports:
Add some programming language test cases.
Remove german code comments.
Upgrade all used node modules.
0.3.0
--marked-..., watch all params with--help.0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
Extend
@apiParam,@apiSuccess,@apiErrorwith a grouping ability. Example@apiParam (group) varname.view @apiParam
Add new Functions:
Minor Template-Bugfixes.
0.1.11
0.1.10
-eexclude option for Files / Directories, exampleapidoc -e node_modules/.0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
v0.24.0Compare Source
v0.23.0Compare Source
v0.22.1Compare Source
v0.22.0Compare Source
v0.20.1Compare Source
v0.20.0Compare Source
@rigwild/apidoc-markdownconverter in README (#839)v0.19.1Compare Source
v0.19.0Compare Source
The number of open pull requests in now 0! :D In this release you'll find one bugfix and also some new features/improvements.
Bugfix:
New features:
Enhancements:
v0.18.0Compare Source
This release comes after more than two years without changes to the code. A lot of things were merged and fixed, so it is possible that this changelog is not entirely complete. Refer to the git log if necessary.
Common
CLI
Template
Maintenance
v0.17.7Compare Source
v0.17.6Compare Source
v0.17.5Compare Source
v0.17.4Compare Source
v0.17.3Compare Source
v0.17.2Compare Source
v0.17.1Compare Source
v0.17.0Compare Source
Add new @apiDeprecated annotation.
Add new @apiPrivate annotation.
CLI
--private false|trueparameter to export@apiPrivatemarked methods.Parser
@apiPrivate. 530Template
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.