Comments (6)
If you send a pull request, I will apply it.
Thanks,
softdevstory
from node-apidoc-markdown.
ah~ your modification is not markdown syntax.
What do you use to view markdown file?
A generated markdown file is working in github. :)
from node-apidoc-markdown.
Hi. In fact, I do not view markdown files. I pass them to jsdoc as tutorials (jsdoc -u option). And I view the resulting html files. Thanks.
from node-apidoc-markdown.
Hi. I just sent the pull request. Thanks.
from node-apidoc-markdown.
Hi. Yes, in my fix, I used html syntax for link targets inside markdown file (as recommended in https://stackoverflow.com/questions/3292903/in-markdown-what-is-the-best-way-to-link-to-a-fragment-of-a-page-i-e-some-id).
Is that a problem that it is not pure markdown syntax?
Seems it is permitted and works in github. And seems markdown links are not standardized, even links to headings without commas (https://en.wikipedia.org/wiki/Markdown#Standardization).
I created a small example project https://github.com/ikarus512/example_tmp that generates one of my api .md files (see current resulted file in out_current/README.md and result with my fix in out_fixed/README.md). Command to generate them was: npm run doc. I really see that current apidoc-markdown2 works fine with links to headers that do not contain comma. And my fix resolves problem to links with comma.
Also if these .md files are used as input to jsdoc as tutorials, then all TOC links in the resulted html documentation do not work (see file out_jsdoc/index.html --> 'Tutorials' menu). Though it can be seen as jsdoc issue... And my fix resolves this problem too (see file out_jsdoc_fixed/index.html).
Thanks.
from node-apidoc-markdown.
Thanks your contribution.
from node-apidoc-markdown.
Related Issues (7)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from node-apidoc-markdown.