31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
|
Documentation README
|
||
|
|
====================
|
||
|
|
|
||
|
|
This is the documentation for Compass. Much of the documentation is read from the
|
||
|
|
sass source files to keep the docs in-line with current state of the code as much as
|
||
|
|
possible.
|
||
|
|
|
||
|
|
If you're reading this, you might be thinking about helping to improve the compass documentation by editing existing documentation or by adding new documentation.
|
||
|
|
|
||
|
|
There are two main kinds of documentation:
|
||
|
|
|
||
|
|
* Tutorials: Describe HOW to use compass.
|
||
|
|
* Reference: Details about WHAT compass has.
|
||
|
|
|
||
|
|
It's possible and encouraged for related tutorials and reference documentation to
|
||
|
|
link to each other.
|
||
|
|
|
||
|
|
## Getting Around the Documentation Project
|
||
|
|
|
||
|
|
* `.compass/config.rb` - This is where the compass configuration is kept.
|
||
|
|
* `content/` - This directory is where content for the documentation project is kept.
|
||
|
|
* `content/reference` - This is where reference documentation is kept.
|
||
|
|
* `content/tutorials` - This is where tutorial documentation is kept.
|
||
|
|
* `content/css` - Third-party, plain old CSS files.
|
||
|
|
* `content/images` - Images. Duh.
|
||
|
|
* `content/javascripts` - Javascripts. Double Duh.
|
||
|
|
* `content/stylesheets` - Sass stylesheets for the project.
|
||
|
|
* `layouts` - Layouts are kept here.
|
||
|
|
* `layouts/partials` - Partials are kept here.
|
||
|
|
* `lib` - Ruby code. Helper code and sass source inspection is done here.
|