├── .gitignore ├── LICENSE └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # node-waf configuration 20 | .lock-wscript 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 27 | node_modules 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Robin Berjon 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # ducted-books 3 | 4 | A Ducted pipeline for book writing 5 | 6 | Just some quick notes at this point. This is going to require: 7 | 8 | * `ducted-style`: for style injection (the CSS is custom to here) 9 | * `ducted-toc`: for ToC generation (take from ReSpec) 10 | * `ducted-load-runner`: basically Ducted runs ASAP (especially with `async`) but sub-pipeline ought to be able to control when they run. Things like `ducted-style` you want running immediately; but the last step in the top-level pipeline should be `ducted-load-runner` that actually only runs its own sub-pipeline when the document is loaded. 11 | * `ducted-writing-stats`: a small plugin that measures the word/character counts, can show them in a floating little panel in the corner, and can even save them (along with the date) at each load so that you can track them over time. 12 | * `ducted-title`: takes the `h1`, sets the `title`. 13 | * `ducted-script-config`: loads the configuration from a `script` with `type='application/ducted+json'`. 14 | * `ducted-ui-panels`: handles the positioning of panels and such UI matters on the side (used by `ducted-writing-stats`) 15 | * `ducted-punctuation-en`: helpfully replaces {s}'{s,t} with ’, "" with “”, ... with … (and perhaps a few others). 16 | * `ducted-load-document`: if given nothing it will try to use the `document`. It can also take in a `path`, a `URL`, a `content`. It will load jsdom if it needs to; using a browserify trick to only load it in Node. 17 | 18 | Throw in a little bit of browserify/watchify/babelify building and we're good to go. 19 | 20 | None of this is complicated, this is a good test of the system. 21 | --------------------------------------------------------------------------------