Web page needed

[dresende]

Readme is getting bigger and bigger with features and options and flags....

One day we'll need a web page to better organize all the information. Using the wiki is not a good idea because everyone can change and ruin other previous work..

Does anyone know of a good documentation builder? (not based on code or comments, maybe based on a list of markdown files and folders..)

[dresende]

I just did a copy of the new express webpage style here if anyone wants to continue.

https://github.com/felixge/node-mysql/tree/webpage/webpage

It would be cool to read the documentation from the Readme or another markdown file. CSS was generated with the Stylus file.

[dresende]

I've made a lot of changes. Not static anymore. To check it out:

1. Update repository

git pull

1. Checkout branch webpage

git checkout webpage

1. Jump to build folder, install dependencies, build documentation

cd webpage/build
npm install
node build

1. Open webpage/build/out/index.html in your browser

[felixge]

So I'm working on a static site generator for Github Pages that should also work great for this:

https://github.com/felixge/node-romulus

We already use it for nodecopter.com: http://github.com/nodecopter/nodecopter.com

Romulus is still missing a few features (like syntax highlighting), but I think it's going into the right direction and I'd like to use it for the mysql docs if we extract them out into a standalone site.

What do you think?

[dresende]

Cool :) I'll look into it and try to use it.

[kai-koch]

I would like to contribute to the documentation.
Should I use the web page branch or the wiki?

[dresende]

I think the wiki is better for now. The branch will probably disappear while we don't choose a base layout for the site.

[kai-koch]

See #370