forked from jashkenas/docco
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docco 0.2.0, with and NPM installer.
- Loading branch information
Showing
6 changed files
with
205 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,8 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| var path = require('path'); | ||
| var fs = require('fs'); | ||
| var lib = path.join(path.dirname(fs.realpathSync(__filename)), '../'); | ||
| var cmd = 'coffee ' + path.join(lib, 'docco.coffee') + ' -- ' + process.ARGV.slice(2).join(' '); | ||
| var fs = require('fs'); | ||
| var lib = path.join(path.dirname(fs.realpathSync(__filename)), '../lib'); | ||
|
|
||
| require('child_process').exec(cmd, function(err, stdout, stderr) { | ||
| if (err) process.stdio.writeError(stderr.read()); | ||
| }); | ||
| process.ARGV = process.argv = process.argv.slice(2, process.argv.length); | ||
| require(lib + '/docco.js'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| (function() { | ||
| var _a, _b, _c, destination, docco_styles, docco_template, ensure_directory, exec, ext, fs, generate_documentation, generate_html, get_language, highlight, highlight_end, highlight_start, l, languages, parse, path, print, puts, showdown, sources, spawn, template; | ||
| var __hasProp = Object.prototype.hasOwnProperty; | ||
| generate_documentation = function(source, callback) { | ||
| return fs.readFile(source, "utf-8", function(error, code) { | ||
| var sections; | ||
| if (error) { | ||
| throw error; | ||
| } | ||
| sections = parse(source, code); | ||
| return highlight(source, sections, function() { | ||
| generate_html(source, sections); | ||
| return callback(); | ||
| }); | ||
| }); | ||
| }; | ||
| parse = function(source, code) { | ||
| var _a, _b, _c, code_text, docs_text, has_code, language, line, lines, save, sections; | ||
| lines = code.split('\n'); | ||
| sections = []; | ||
| language = get_language(source); | ||
| has_code = (docs_text = (code_text = '')); | ||
| save = function(docs, code) { | ||
| return sections.push({ | ||
| docs_text: docs, | ||
| code_text: code | ||
| }); | ||
| }; | ||
| _b = lines; | ||
| for (_a = 0, _c = _b.length; _a < _c; _a++) { | ||
| line = _b[_a]; | ||
| if (line.match(language.comment_matcher)) { | ||
| if (has_code) { | ||
| save(docs_text, code_text); | ||
| has_code = (docs_text = (code_text = '')); | ||
| } | ||
| docs_text += line.replace(language.comment_matcher, '') + '\n'; | ||
| } else { | ||
| has_code = true; | ||
| code_text += line + '\n'; | ||
| } | ||
| } | ||
| save(docs_text, code_text); | ||
| return sections; | ||
| }; | ||
| highlight = function(source, sections, callback) { | ||
| var _a, _b, _c, _d, language, output, pygments, section; | ||
| language = get_language(source); | ||
| pygments = spawn('pygmentize', ['-l', language.name, '-f', 'html', '-O', 'encoding=utf-8']); | ||
| output = ''; | ||
| pygments.stderr.addListener('data', function(error) { | ||
| if (error) { | ||
| return puts(error); | ||
| } | ||
| }); | ||
| pygments.stdout.addListener('data', function(result) { | ||
| if (result) { | ||
| return output += result; | ||
| } | ||
| }); | ||
| pygments.addListener('exit', function() { | ||
| var _a, _b, fragments, i, section; | ||
| output = output.replace(highlight_start, '').replace(highlight_end, ''); | ||
| fragments = output.split(language.divider_html); | ||
| _a = sections; | ||
| for (i = 0, _b = _a.length; i < _b; i++) { | ||
| section = _a[i]; | ||
| section.code_html = highlight_start + fragments[i] + highlight_end; | ||
| section.docs_html = showdown.makeHtml(section.docs_text); | ||
| } | ||
| return callback(); | ||
| }); | ||
| pygments.stdin.write((function() { | ||
| _a = []; _c = sections; | ||
| for (_b = 0, _d = _c.length; _b < _d; _b++) { | ||
| section = _c[_b]; | ||
| _a.push(section.code_text); | ||
| } | ||
| return _a; | ||
| })().join(language.divider_text)); | ||
| return pygments.stdin.end(); | ||
| }; | ||
| generate_html = function(source, sections) { | ||
| var dest, html, title; | ||
| title = path.basename(source); | ||
| dest = destination(source); | ||
| html = docco_template({ | ||
| title: title, | ||
| sections: sections, | ||
| sources: sources, | ||
| path: path, | ||
| destination: destination | ||
| }); | ||
| puts("docco: " + (source) + " -> " + (dest)); | ||
| return fs.writeFile(dest, html); | ||
| }; | ||
| fs = require('fs'); | ||
| path = require('path'); | ||
| showdown = require('./../vendor/showdown').Showdown; | ||
| _a = require('child_process'); | ||
| spawn = _a.spawn; | ||
| exec = _a.exec; | ||
| _b = require('sys'); | ||
| puts = _b.puts; | ||
| print = _b.print; | ||
| languages = { | ||
| '.coffee': { | ||
| name: 'coffee-script', | ||
| symbol: '#' | ||
| }, | ||
| '.js': { | ||
| name: 'javascript', | ||
| symbol: '//' | ||
| }, | ||
| '.rb': { | ||
| name: 'ruby', | ||
| symbol: '#' | ||
| } | ||
| }; | ||
| _c = languages; | ||
| for (ext in _c) { | ||
| if (!__hasProp.call(_c, ext)) continue; | ||
| l = _c[ext]; | ||
| l.comment_matcher = new RegExp('^\\s*' + l.symbol + '\\s?'); | ||
| l.divider_text = '\n' + l.symbol + 'DIVIDER\n'; | ||
| l.divider_html = new RegExp('\\n*<span class="c1">' + l.symbol + 'DIVIDER<\\/span>\\n*'); | ||
| } | ||
| get_language = function(source) { | ||
| return languages[path.extname(source)]; | ||
| }; | ||
| destination = function(filepath) { | ||
| return 'docs/' + path.basename(filepath, path.extname(filepath)) + '.html'; | ||
| }; | ||
| ensure_directory = function(callback) { | ||
| return exec('mkdir -p docs', function() { | ||
| return callback(); | ||
| }); | ||
| }; | ||
| template = function(str) { | ||
| return new Function('obj', 'var p=[],print=function(){p.push.apply(p,arguments);};' + 'with(obj){p.push(\'' + str.replace(/[\r\t\n]/g, " ").replace(/'(?=[^<]*%>)/g, "\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g, "',$1,'").split('<%').join("');").split('%>').join("p.push('") + "');}return p.join('');"); | ||
| }; | ||
| docco_template = template(fs.readFileSync(__dirname + '/../resources/docco.jst').toString()); | ||
| docco_styles = fs.readFileSync(__dirname + '/../resources/docco.css').toString(); | ||
| highlight_start = '<div class="highlight"><pre>'; | ||
| highlight_end = '</pre></div>'; | ||
| sources = process.ARGV.sort(); | ||
| if (sources.length) { | ||
| ensure_directory(function() { | ||
| var files, next_file; | ||
| fs.writeFile('docs/docco.css', docco_styles); | ||
| files = sources.slice(0); | ||
| next_file = function() { | ||
| if (files.length) { | ||
| return generate_documentation(files.shift(), next_file); | ||
| } | ||
| }; | ||
| return next_file(); | ||
| }); | ||
| } | ||
| })(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "name": "docco", | ||
| "description": "The Quick and Dirty Literate Programming Documentation Generator", | ||
| "keywords": ["documentation", "docs", "generator", "coffeescript"], | ||
| "author": "Jeremy Ashkenas", | ||
| "version": "0.2.0", | ||
| "licenses": [{ | ||
| "type": "MIT", | ||
| "url": "http://opensource.org/licenses/mit-license.php" | ||
| }], | ||
| "engines": { | ||
| "node": ">=0.2.0" | ||
| }, | ||
| "directories": { | ||
| "lib" : "./lib" | ||
| }, | ||
| "main" : "./lib/docco", | ||
| "bin": { | ||
| "docco": "./bin/docco", | ||
| } | ||
| } |
Oops, something went wrong.