atotic / fancy-doc-viewer

Polymer-style docs for everyone

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fancy-doc-viewer

What

Polymer-style docs for your own site.

Motivation

I've never been happy with my own docs. They are a pain to maintain, and the payoff comes 6 months later: "Did I really write this?"

fancy-doc-viewer is useful right away. It combines your component docs with docs for all the other components used by your project, plus your txt and markdown docs.

Demo

Try a demo

Development

setup: bower install

running: http-server -c 1 .. # -c 1 option avoids stale cache when editing docs

index: http://localhost:8080/fancy-doc-viewer/index.html

testing: http://localhost:8080/fancy-doc-viewer/test/index.html

About

Polymer-style docs for everyone


Languages

Language:JavaScript 64.9%Language:CSS 35.1%