Browse files

add docs about the docs

Closes #636, closes #639
  • Loading branch information...
mislav committed Nov 11, 2012
1 parent dea8af9 commit 9e9682a14bc34c141de9f51c55e0b9390b5b95ca
Showing with 13 additions and 1 deletion.
  1. +13 −1
@@ -3,7 +3,7 @@
Zepto is a minimalist JavaScript library for modern browsers with a
largely jQuery-compatible API. If you use jQuery, you already know how to use Zepto.
-See []( for an extended introduction, downloads
+See [][] for an extended introduction, downloads
and documentation.
Zepto.js is licensed under the terms of the MIT License.
@@ -164,6 +164,16 @@ Get in touch:
* IRC channel: [#zepto on](irc://
* @[zeptojs](
+### Write documentation
+Zepto docs are written in Markdown and live in the ["gh-pages" branch][docs].
+They are published on [][].
+You can use GitHub's web interface to make quick changes to documentation for
+specific Zepto features
+([example: ajaxSettings](
+This will submit a pull request to us that we can review.
### Report a bug
1. Check if the bug is already fixed in the [master branch][master] since the
@@ -209,8 +219,10 @@ $ script/test test/selector.html
* Use comments to describe non-obvious code behavior
+ []:
+ [docs]:

0 comments on commit 9e9682a

Please sign in to comment.