Comments (6)
Taking a quick look it seems that the current docs are written in the pdoc style which has the advantage of being markdown - which seems appropriate for a markdown module.
That being said there is nothing currently rendering these docs so they are essentially just free-form comments right now. Having them asa browsable webpage might be useful.
Can you show me a sample of the output for a few of the methods for this module?
from markdown-js.
Of course, I haven't finished everything but I fixed up the docs at the top and formatted it in yuidoc format (it's a quick change).
This is the default skin which inherits from the rest of the YUI modules, but is customizable: http://j.shirley.im/tech/yui/gallery-markdown/docs/classes/Markdown.html
Also, yuidoc has full Markdown support as well, which I made usage of to format the synopsis.
Thanks!
On Jun 17, 2012, at 11:27 AM, Ash Berlin wrote:
Taking a quick look it seems that the current docs are written in the pdoc style which has the advantage of being markdown - which seems appropriate for a markdown module.
That being said there is nothing currently rendering these docs so they are essentially just free-form comments right now. Having them asa browsable webpage might be useful.
Can you show me a sample of the output for a few of the methods for this module?
Reply to this email directly or view it on GitHub:
#53 (comment)
from markdown-js.
Can YUIDoc support params of variable types? i.e. the dialect
param to parse
is either the dialect name (well the key in Markdown.dialects) or a dialect object (with the right methods - we don't check validity of them at the moment, just blindly assume any object is 'correct')
from markdown-js.
It's more or less free-form, http://yui.github.com/yuidoc/syntax/index.html#param
What I typically see is something like @param dialect {String | Object} $description
(and what I used in some places). The neat thing about @param is that they're nested, so when you have an object you can nest it down (the example in the link above shows that).
On Jun 17, 2012, at 12:00 PM, Ash Berlin wrote:
Can YUIDoc support params of variable types? i.e. the
dialect
param toparse
is either the dialect name (well the key in Markdown.dialects) or a dialect object (with the right methods - we don't check validity of them at the moment, just blindly assume any object is 'correct')
Reply to this email directly or view it on GitHub:
#53 (comment)
from markdown-js.
By the way, it sounds like you are at least interested.
Shall I fork and submit a pull request with the documentation formatting changes? Then we can comment on actual code :)
On Jun 17, 2012, at 12:00 PM, Ash Berlin wrote:
Can YUIDoc support params of variable types? i.e. the
dialect
param toparse
is either the dialect name (well the key in Markdown.dialects) or a dialect object (with the right methods - we don't check validity of them at the moment, just blindly assume any object is 'correct')
Reply to this email directly or view it on GitHub:
#53 (comment)
from markdown-js.
Sure go for it.
Its a little bit javadoc for my linking but that's just my old hangup against Java.
from markdown-js.
Related Issues (20)
- Link to `lib/markdown.js` not working in readme HOT 1
- Strikethrough component doesn't work. HOT 1
- Code Syntax Highlight
- Unable to resolve module `../../constants/index` from `D:\GitHub\medred\app\src\ stories\screens\Specialty\index.js`: could not resolve `D:\GitHub\medred\app\src \stories\constants\index' as a folder: it did not contain a package, nor an inde x file
- Can't distinguish code language HOT 1
- support parase "[TOC]"? HOT 1
- [BUG] href not correctly parsed when text and its url both contains underscore. HOT 3
- *** Text *** parse was strong , but Italic not effective HOT 1
- Two links following one another
- Add note to README that this repo is not maintained HOT 2
- The speed of the Markdown-js is too bad. HOT 2
- Load external Markdown File in html.
- Inline HTML is escaped? HOT 2
- Vulnerability issue HOT 2
- 🚨 Potential Security Vulnerability HOT 1
- Trying to get in touch regarding a security issue HOT 1
- Images not getting converted properly in certain cases
- (wrong repository) HOT 1
- the "table" cannot use HOT 4
- how to convert .md file into .html
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 markdown-js.