From c4dc47a2f171498af6b636dfc626a530fb9c5602 Mon Sep 17 00:00:00 2001 From: Chris Eppstein Date: Sat, 1 May 2010 15:24:28 -0700 Subject: [PATCH] [Docs] Move and update the documentation on the new compass command line. --- .../content/tutorials/command-line.markdown | 109 ++++++++++++++++++ old_docs/COMMAND_LINE.markdown | 68 ----------- 2 files changed, 109 insertions(+), 68 deletions(-) create mode 100644 doc-src/content/tutorials/command-line.markdown delete mode 100644 old_docs/COMMAND_LINE.markdown diff --git a/doc-src/content/tutorials/command-line.markdown b/doc-src/content/tutorials/command-line.markdown new file mode 100644 index 00000000..06c35662 --- /dev/null +++ b/doc-src/content/tutorials/command-line.markdown @@ -0,0 +1,109 @@ +--- +title: Compass Command Line Documentation +layout: tutorial +classnames: + - tutorial +--- +Compass Command Line Documentation +================================== + +This page lists the compass commands you can use to set up and manage your project. + +You may also find one of these walk throughs useful: + +* HOWTO: [Compile your stylesheets for production](/docs/tutorials/production-css/) + + + +Project Commands +---------------- + +### Create a new compass project + + compass create path/to/project [--using blueprint] [--sass-dir=sass ...] [--project-type=rails] + + +### Initialize an existing project to work with compass + + compass init rails path/to/project [--using blueprint] + +### Install a pattern from an extension into a project + + compass install blueprint/buttons [path/to/project] + +### Compile the project's sass files into css + + compass compile [path/to/project] + +### Watch the project for changes and compile whenever it does + + compass watch [path/to/project] + +### Emit a configuration file at the location specified. + + compass config [path/to/config] [--sass-dir=sass --css-dir=css ...] + +### Validate the generated CSS. + + compass validate [path/to/project] + +Misc commands +------------- + +### Generate a background image that can be used to verify grid alignment + + compass grid-img W+GxH [path/to/grid.png] + +### Enter into a console for testing SassScript in a compass environment. + + compass interactive + +### Print out statistics about your stylesheets + + compass stats + +### Emit the version of compass + + compass version + +Get Help on the Command Line +---------------------------- + +### Get help on compass + + compass help + +### Get help on an extension + + compass help extension_name + +### Get help about an extension pattern + + compass help extension_name/pattern_name + +### Get help about a particular sub command + + compass help command_name + diff --git a/old_docs/COMMAND_LINE.markdown b/old_docs/COMMAND_LINE.markdown deleted file mode 100644 index 540ee905..00000000 --- a/old_docs/COMMAND_LINE.markdown +++ /dev/null @@ -1,68 +0,0 @@ -Compass Command Line Documentation -================================== - -Extensions Commands -------------------- - - # install a global extension. probably requires sudo. - compass extension install extension_name - - # install an extension into a project - compass extension unpack extension_name [path/to/project] - - # uninstall a local or global extension. global extensions will require sudo. - compass extension uninstall extension_name [path/to/project] - - # list the extensions in the project - compass extensions list - - # list the extensions available for install - compass extensions available - -Project Commands ----------------- - - # Create a new compass project - compass create path/to/project [--using blueprint] [--sass-dir=sass ...] [--project-type=rails] - - # Initialize an existing project to work with compass - compass init rails path/to/project [--using blueprint] - - # Install a pattern from an extension into a project - compass install blueprint/buttons [path/to/project] - - # Compile the project's sass files into css - compass compile [path/to/project] - - # Watch the project for changes and compile whenever it does - compass watch [path/to/project] - - # Emit a configuration file at the location specified. - compass config [path/to/config] [--sass-dir=sass --css-dir=css ...] - - # Validate the generated CSS. - compass validate [path/to/project] - -misc commands -------------- - - # Generate a background image that can be used to verify grid alignment - compass grid-img W+GxH [path/to/grid.png] - - # Emit the version of compass - compass version - - # Get help on compass - compass help - - # Get help on an extension - compass help extension_name - - # Get help about an extension pattern - compass help extension_name/pattern_name - - # Get help about a particular sub command - compass help command_name - - -