Not that I disagree with Isaacs, but regardless of what you use for your module and regardless if you prebuild before pushing it or your module depends on coffescript (i dont suggest this), it seems important to me that you document it with javascript examples so you can reach a bigger audience because it is the min common denominator.
And please dont you dare to start the discussion about cs vs js again. El 24/02/2013 14:05, "Isaac Schlueter" <[email protected]> escribió: > We only highlight JavaScript code correctly on the website. I'd like > to just not automatically highlight any other language, actually. > (There are often command line examples or output samples that get > highlighted strangely.) > > Example code should be in JavaScript because CoffeeScript packages > should be prebuilt and published as JavaScript. That is the lingua > franca of the web, and the language of Node.js. > > > On Sat, Feb 23, 2013 at 7:59 AM, Diogo Resende <[email protected]> > wrote: > > It seems to work for me, the only thing that doesn't seem to highlight > > correctly is coffee script. > > > > -- > > Diogo Resende > > > > On Saturday, February 23, 2013 at 15:37 , Tim Caswell wrote: > > > > I would think the easiest route would be sending Isaac a pull request > > (assuming the npm website is on github). I can't imagine he would be > > against making this match github's markdown features. > > > > > > On Fri, Feb 22, 2013 at 7:13 AM, Michal Srb <[email protected]> wrote: > > > > Hi, > > > > I was trying to find any information about this, but I couldn't. It seems > > that NPM's README rendering (on NPM website), does not use Github > flavored > > markdown. How can I / should I practically include two separate README > > files, one for github and one for npm? What is the best practice? > > > > For example of failure, compare: > > > > https://npmjs.org/package/metacoffee > > https://github.com/xixixao/meta-coffee > > > > Thanks, > > > > Michal > > > > -- > > -- > > Job Board: http://jobs.nodejs.org/ > > Posting guidelines: > > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > > You received this message because you are subscribed to the Google > > Groups "nodejs" group. > > To post to this group, send email to [email protected] > > To unsubscribe from this group, send email to > > [email protected] > > For more options, visit this group at > > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > --- > > You received this message because you are subscribed to the Google Groups > > "nodejs" group. > > To unsubscribe from this group and stop receiving emails from it, send an > > email to [email protected]. > > For more options, visit https://groups.google.com/groups/opt_out. > > > > > > > > > > -- > > -- > > Job Board: http://jobs.nodejs.org/ > > Posting guidelines: > > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > > You received this message because you are subscribed to the Google > > Groups "nodejs" group. > > To post to this group, send email to [email protected] > > To unsubscribe from this group, send email to > > [email protected] > > For more options, visit this group at > > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > --- > > You received this message because you are subscribed to the Google Groups > > "nodejs" group. > > To unsubscribe from this group and stop receiving emails from it, send an > > email to [email protected]. > > For more options, visit https://groups.google.com/groups/opt_out. > > > > > > > > > > -- > > -- > > Job Board: http://jobs.nodejs.org/ > > Posting guidelines: > > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > > You received this message because you are subscribed to the Google > > Groups "nodejs" group. > > To post to this group, send email to [email protected] > > To unsubscribe from this group, send email to > > [email protected] > > For more options, visit this group at > > http://groups.google.com/group/nodejs?hl=en?hl=en > > > > --- > > You received this message because you are subscribed to the Google Groups > > "nodejs" group. > > To unsubscribe from this group and stop receiving emails from it, send an > > email to [email protected]. > > For more options, visit https://groups.google.com/groups/opt_out. > > > > > > -- > -- > Job Board: http://jobs.nodejs.org/ > Posting guidelines: > https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines > You received this message because you are subscribed to the Google > Groups "nodejs" group. > To post to this group, send email to [email protected] > To unsubscribe from this group, send email to > [email protected] > For more options, visit this group at > http://groups.google.com/group/nodejs?hl=en?hl=en > > --- > You received this message because you are subscribed to the Google Groups > "nodejs" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/groups/opt_out. > > > -- -- Job Board: http://jobs.nodejs.org/ Posting guidelines: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines You received this message because you are subscribed to the Google Groups "nodejs" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/nodejs?hl=en?hl=en --- You received this message because you are subscribed to the Google Groups "nodejs" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/groups/opt_out.
