tinydoc requires Node.js to run and you can get it through NPM by running:
npm install -g tinydoc
tinydoc --help for more information.
tinydoc will look for a file called
tinydoc.conf.js in the CWD, or use the file specified using the
moduleexports =outputDir: "./public/doc";
For the actual configuration parameters, please refer to each plugin's README file found under
You can find them here: http://tinydoc.netlify.com/.
tinydoc accepts plugins that can hook into the compilation of the docs. The compilation is composed of several phases:
The UI of tinydoc is written in React and is also extensible through different means: outlets and full-fledged plugins.
TODO: UI plugin guide.
npm run test:ui npm run test:ui:packages
Copyright (C) 2015 Ahmad Amireh
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.