Repository navigation
Output Markdown is missing some newlines, but not all #1595
Description
When running documentation on a project or single file, from powershell CLI or built in VSCode CLI, markdown and html formatting is messy.
Version: 14.0.1 & 14.0.0
Input code:
/**
* Extracts a literal value by removing double curly braces
*
* @since v0.0.1
* @category Helpers
* @param {string} val - The string to process
* @returns {string}
* @example
* getTemplateLiteral('test') //=> ''
* getTemplateLiteral('{{test}}') //=> 'test'
* getTemplateLiteral('{{{test}}}') //=> '{test}'
* getTemplateLiteral('{{}}test') //=> ''
* getTemplateLiteral('{{}}') //=> ''
*/
export const getTemplateLiteral = (val) => {
if (String(val).startsWith('{{') && String(val).endsWith('}}')){
return String(val).slice(2,-2);
}
return '';
};Command from CLI: documentation build src/helpers/getTemplateLiteral.ts -f md -o README.md
Output README.md:
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->### Table of Contents* [getTemplateLiteral][1]
* [Parameters][2]
* [Examples][3]## getTemplateLiteralExtracts a literal value by removing double curly braces### Parameters* `val` **[string][4]** The string to process### Examples```javascript
getTemplateLiteral('test') //=> ''
getTemplateLiteral('{{test}}') //=> 'test'
getTemplateLiteral('{{{test}}}') //=> '{test}'
getTemplateLiteral('{{}}test') //=> ''
getTemplateLiteral('{{}}') //=> ''
```Returns **[string][4]** **Meta*** **since**: v0.0.1[1]: #gettemplateliteral[2]: #parameters[3]: #examples[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/StringNot sure if I've made a mistake here, but the output seems to be formatted very strangely, is this a bug?
Raw files attached to check line endings
README.md
getTemplateLiteral.txt
Activity
ingun37 commentedon May 19, 2023
Did you find solution to this?
dataclear commentedon May 19, 2023
No, I ended up using a different documentation compiler.
ingun37 commentedon May 19, 2023
FYI, I fixed by downgrading to 13.
baydoun0 commentedon May 23, 2024
I can reproduce this as well in 14.0.3. Pretty annoying, and not worth the deep dive.