question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Creating one markdown file per file

See original GitHub issue

I would like to generate one .md file per input file, skipping the automatic concatenation. Something like this should work:

jsdoc2md  --configure=.jsdocrc --out=dist/jsdocs/ js/**/*.js

In:

+-- js/
|   +-- lib/
|       +-- foo.js
|   +-- a.js
|   +-- b.js

Out:

+-- dist/
|   +-- jsdocs/
|       +-- lib/
|           +-- foo.md
|       +-- a.md
|       +-- b.md

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:10 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
75lbcommented, Sep 23, 2016

hi @kulakowka… i don’t plan to add this specific behaviour to the cli because it is not what the majority of users need, sorry.

2reactions
75lbcommented, Sep 26, 2016

well, there is an example script showing how to achieve this in jsdoc2md v1… i will write a similar example for v2 ASAP.

I’m still working on V2 - almost there, it’s at preview stage atm.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Getting Started | Markdown Guide
Create a Markdown file using a text editor or a dedicated Markdown application. · Open the Markdown file in a Markdown application. ·...
Read more >
Markdown and including multiple files - Stack Overflow
Specifically, I want to create a separate markdown file with links that I call often but not always (call this B.md), then when...
Read more >
How to create a Readme.md file? - Medium
INSTRUCTIONS · Open any text editor or notepad. · Create a new file from — →file →new file. · Save the file as...
Read more >
Multi-file Documents - Marked 2
Using this feature you can build large documents/books using multiple files (e.g. a file for each chapter) and then specify the document order...
Read more >
Create documents with Markdown-formatted text and Stata ...
Learn how to embed Stata output in text files, HTML files, and Word documents. We show you how to use dynamic tags to...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found