This repository has been archived by the owner on May 31, 2019. It is now read-only.
forked from electron/node
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Build API page into build/doc; simplify doctool.
- Loading branch information
Showing
3 changed files
with
117 additions
and
133 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
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,138 +1,86 @@ | ||
| var fs = require("fs") | ||
| , path = require("path") | ||
| , cp = require('child_process') | ||
| , markdown = require("./markdown"); | ||
| /* | ||
| Process a single doc file | ||
| var cwd = process.cwd() | ||
| , doc_root = path.join(cwd, "doc/api/") | ||
| , build_root = path.join(cwd, "doc/api/") | ||
| , assets_path = path.join(cwd, "doc/api_assets/") | ||
| , bassets_path = path.join(build_root, "assets/"); | ||
| argv[2] = template file | ||
| argv[3] = input file | ||
| argv[4] = output file | ||
| /* | ||
| A simple step / flow-control pattern, so that I can make the code in this file | ||
| just a little bit more easy to follow. | ||
| */ | ||
| var step = function(){ | ||
| var self = this; | ||
| this.steps = Array.prototype.slice.call(arguments); | ||
| this.index = 0; | ||
| this.next = function(){ | ||
| var index = self.index++; | ||
| return function(){ | ||
| if(index < self.steps.length){ | ||
| self.steps[index](self.next()); | ||
| } else { | ||
| return function(){}; | ||
| } | ||
| }; | ||
| }; | ||
| return this.next(); | ||
| }; | ||
| var fs = require("fs"), | ||
| path = require("path"), | ||
| markdown = require("./markdown"), | ||
| argv = process.argv, | ||
| argc = argv.length; | ||
|
|
||
| var template = fs.readFileSync(argv[2], "utf8"); | ||
|
|
||
| var ids = {}; | ||
|
|
||
| function formatIdString(str){ | ||
| str = str | ||
| .replace(/\([^)}]*\)/gmi, "") | ||
| .replace(/[^A-Za-z0-9_.]+/gmi, "_"); | ||
|
|
||
| return str.substr(0,1).toLowerCase() + str.substr(1); | ||
| } | ||
|
|
||
|
|
||
| var includeExpr = /^@include\s+([A-Za-z0-9-_]+)(?:\.)?([a-zA-Z]*)$/gmi; | ||
| function convertData(data){ | ||
| function convertData(data, current_file){ | ||
| // Allow including other pages in the data. | ||
| data = data.replace(includeExpr, function(src, name, ext){ | ||
| try { | ||
| var inc_path = path.join(doc_root, name+"."+(ext || "markdown")); | ||
| return fs.readFileSync(inc_path, "utf8"); | ||
| } catch(e) { | ||
| return ""; | ||
| } | ||
| }); | ||
|
|
||
| function loadIncludes(data){ | ||
| return data.replace(includeExpr, function(src, name, ext){ | ||
| try { | ||
| var include_path = path.join(current_file, "../", name+"."+(ext || "markdown")) | ||
| return loadIncludes(fs.readFileSync(include_path, "utf8")); | ||
| } catch(e) { | ||
| return ""; | ||
| } | ||
| }); | ||
| }; | ||
|
|
||
| data = loadIncludes(data); | ||
|
|
||
| // Convert it to HTML from Markdown | ||
| if(data.length == 0){ | ||
| data = "Sorry, this section is currently undocumented, but we'll be working on it."; | ||
| } | ||
|
|
||
| return markdown.toHTML(markdown.parse(data), {xhtml:true}); | ||
| }; | ||
|
|
||
| /* | ||
| Ensures that the output directory exists, this can probably be done in the | ||
| makefile. | ||
| */ | ||
| function checkdir(next){ | ||
| fs.stat(build_root, function(err){ | ||
| if(err) { | ||
| // easiest way to recursively create directories without doing loops. | ||
| cp.exec("mkdir -p "+build_root, function(err, stdout, stderr){ | ||
| next(); | ||
| }); | ||
| } else { | ||
| next(); | ||
| } | ||
| }) | ||
| }; | ||
| data = markdown.toHTML(markdown.parse(data), {xhtml:true}); | ||
|
|
||
| /* | ||
| Loads the template for which the documentation should be outputed into. | ||
| */ | ||
| var template; | ||
|
|
||
| function loadTemplates(next){ | ||
| fs.readFile(path.join(doc_root, "../template.html"), "utf8", function(e, d){ | ||
| if(e) throw e; | ||
|
|
||
| template = d; | ||
| next(); | ||
| data = data.replace(/<hr><\/hr>/g, "<hr />"); | ||
|
|
||
| data = data.replace(/(\<h[2-6])\>([^<]+)(\<\/h[1-6]\>)/gmi, function(o, ts, c, te){ | ||
| var id = formatIdString(c); | ||
| return ts+' id="'+id+'">'+c+te; | ||
| }); | ||
|
|
||
| return data; | ||
| }; | ||
|
|
||
| if(argc > 3){ | ||
| var filename = argv[3]; | ||
|
|
||
| /* | ||
| This function reads the doc/api/* directory, and filters out any files | ||
| that are not markdown files. It then converts the markdown to HTML, and | ||
| outputs it into the previously loaded template file. | ||
| */ | ||
| function convertFiles(next){ | ||
| fs.readdir(doc_root, function(err, files){ | ||
| fs.readFile(filename, "utf8", function(err, data){ | ||
| if(err) throw err; | ||
|
|
||
| files.filter(function(file){ | ||
| var basename = path.basename(file, ".markdown"); | ||
| return path.extname(file) == ".markdown" && | ||
| basename.substr(0,1) != "_"; | ||
| }).forEach(function(file){ | ||
| var filename = path.basename(file, '.markdown') | ||
| , build_path = path.join(build_root, filename+".html") | ||
| , doc_path = path.join(doc_root, file); | ||
|
|
||
| fs.readFile(doc_path, "utf8", function(err, data){ | ||
| if(err) throw err; | ||
|
|
||
| // do conversion stuff. | ||
| var html = convertData(data); | ||
| var output = template.replace("{{content}}", html); | ||
|
|
||
| if(filename == "index"){ | ||
| output = output.replace("{{section}}", ""); | ||
| } else { | ||
| output = output.replace("{{section}}", filename+" - ") | ||
| } | ||
|
|
||
| fs.writeFile(build_path, output, function(err){ | ||
| if(err) throw err; | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| // we don't need the next call to wait at all, so stick it here. | ||
| next(); | ||
| }; | ||
|
|
||
| function copyAssets(next){ | ||
| cp.exec("cp -R "+assets_path+" "+bassets_path, function(err, stdout, stderr){ | ||
| next(); | ||
| }); | ||
| }; | ||
| // do conversion stuff. | ||
| var html = convertData(data, filename); | ||
| var output = template.replace("{{content}}", html); | ||
|
|
||
| filename = path.basename(filename, '.markdown'); | ||
|
|
||
| if(filename == "index"){ | ||
| output = output.replace("{{section}}", ""); | ||
| output = output.replace(/<body([^>]*)>/, '<body class="index" $1>'); | ||
| } else { | ||
| output = output.replace("{{section}}", filename+" - ") | ||
| } | ||
|
|
||
| step( | ||
| checkdir, | ||
| copyAssets, | ||
| loadTemplates, | ||
| convertFiles | ||
| )(); | ||
| if(argc > 4) { | ||
| fs.writeFile(argv[4], output); | ||
| } else { | ||
| process.stdout.write(output); | ||
| } | ||
| }); | ||
| } |