Geno is a small and opinionated static site generator for easily generating a simple site for your NPM projects based on the project's
Because hand crafting a new site for each project can be quite tedious.
npm install -g geno
Run the following in the root directory of your project:
BOOM! Your project site has been generated.
geno.json in your project's root directory will enable you to add some additional information to your site:
titleis used for naming your module. For example, if you have a module registered as
node-my-modulebut you want to call it
My Moduleyou can add your own value and easily change that. It'll otherwise default to the
namein specified in the
introductionis a longer description field that can be used in favor of the
installationis used for adding some additional installation instructions.
usageis for adding notes about the basic usage.
outputis where the site will be generated. The default directory is
templateis used for using your own custom template file.
stylesheetis used for using your own custom stylesheet file.
doccois for simply linking to your Docco-generated documentation.
endorseadds a link to this repository in site's footer. It's turned off by default.
Nunjucks is used as the default templating engine.
The MIT License (MIT)
Copyright (c) 2013 Ellen Gummesson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.