JSRocksHQ / harmonic

The next static site generator
http://harmonicjs.com/
MIT License
282 stars 26 forks source link

add docs, fixes #181 #183

Closed UltCombo closed 8 years ago

UltCombo commented 8 years ago

This is part of the docs migration from the Wiki to the main repository. (#181)

I've renamed the "Home" doc page to README so it is shown when you open the repository's doc directory on GitHub. (note: I'll erase this branch after merging, if you are reading the commit history then replace "doc/doc" with "master/doc")

Please test to see if all the documentation's links are working properly.

I've fixed a few typos and broken links in this migration as well.

Side-note: I've removed the "LICENSE" from the package.json's files array as the LICENSE file is always included regardless of settings (https://docs.npmjs.com/files/package.json#files).

UltCombo commented 8 years ago

The failing test is due to ESLint; should be fixed once we update the dependencies (#176, #177).

UltCombo commented 8 years ago

This is looking good to me, I'll go ahead and merge this. Please send PRs or comment if you find any issues in the new docs.