diff --git a/doc-src/content/tutorials/configuration-reference.markdown b/doc-src/content/tutorials/configuration-reference.markdown index ff6807d2..4bed3d25 100644 --- a/doc-src/content/tutorials/configuration-reference.markdown +++ b/doc-src/content/tutorials/configuration-reference.markdown @@ -66,158 +66,165 @@ command line will override the corresponding settings in your configuration file ## Configuration Properties -
Property Name | -Type | -Description | -
---|---|---|
project_type |
- Symbol | -Can be :stand_alone or
- :rails . Defaults to :stand_alone .
- |
-
environment |
- Symbol | -The environment mode.
- Defaults to :production , can also be :development
- |
-
project_path |
- String | -Not needed in :stand_alone mode
- where it can be inferred by context. Sets the path to the root of the project.
- |
-
http_path |
- String | -The path to the project when running within the
- web server. Defaults to "/" .
- |
-
css_dir |
- String | -The directory where the css stylesheets are kept.
- It is relative to the project_path .
- Defaults to "stylesheets" .
- |
-
css_path |
- String | -The full path to where css stylesheets are kept.
- Defaults to <project_path>/<css_dir> .
- |
-
http_stylesheets_path |
- String | -The full http path to stylesheets on the web server. Defaults to http_path + "/" + css_dir . |
-
sass_dir |
- String | -The directory where the sass stylesheets are kept.
- It is relative to the project_path . Defaults to "src" .
- |
-
sass_path |
- String | -The full path to where sass stylesheets are kept.
- Defaults to <project_path>/<sass_dir> .
- |
-
images_dir |
- String | -The directory where the images are kept.
- It is relative to the project_path .
- Defaults to "images" .
- |
-
images_path |
- String | -The full path to where images are kept.
- Defaults to <project_path>/<images_dir> .
- |
-
http_images_path |
- String | -The full http path to images on the web server.
- Defaults to http_path + "/" + images_dir .
- |
-
javascripts_dir |
- String | -The directory where the javascripts are kept.
- It is relative to the project_path . Defaults to
- "javascripts" .
- |
-
javascripts_path |
- String | -The full path to where javascripts are kept.
- Defaults to <project_path>/<javascripts_dir> .
- |
-
http_javascripts_path |
- String | -The full http path to javascripts on the web server.
- Defaults to http_path + "/" + javascripts_dir .
- |
-
output_style |
- Symbol | -The output style for the compiled css.
- One of: :nested , :expanded , :compact ,
- or :compressed .
- |
-
relative_assets |
- Boolean | -Indicates whether the compass helper functions - should generate relative urls from the generated css to assets, or absolute urls - using the http path for that asset type. - | -
additional_import_paths |
- Array of Strings | -Other paths on your system from which to import
- sass files. See the add_import_path function for a simpler
- approach.
- |
-
sass_options |
- Hash | -These options are passed directly to the - Sass compiler. For more details on the format of sass options, please read the - sass options documentation. - | -
line_comments |
- Boolean | -Indicates whether line comments should be added - to compiled css that says where the selectors were defined. Defaults to false - in production mode, true in development mode. - | -
Property Name | +Type | +Description | +
---|---|---|
project_type |
+ Symbol | +Can be :stand_alone or
+ :rails . Defaults to :stand_alone .
+ |
+
environment |
+ Symbol | +The environment mode.
+ Defaults to :production , can also be :development
+ |
+
project_path |
+ String | +Not needed in :stand_alone mode
+ where it can be inferred by context. Sets the path to the root of the project.
+ |
+
http_path |
+ String | +The path to the project when running within the
+ web server. Defaults to "/" .
+ |
+
css_dir |
+ String | +The directory where the css stylesheets are kept.
+ It is relative to the project_path .
+ Defaults to "stylesheets" .
+ |
+
css_path |
+ String | +The full path to where css stylesheets are kept.
+ Defaults to <project_path>/<css_dir> .
+ |
+
http_stylesheets_path |
+ String | +The full http path to stylesheets on the web server. Defaults to http_path + "/" + css_dir . |
+
sass_dir |
+ String | +The directory where the sass stylesheets are kept.
+ It is relative to the project_path . Defaults to "src" .
+ |
+
sass_path |
+ String | +The full path to where sass stylesheets are kept.
+ Defaults to <project_path>/<sass_dir> .
+ |
+
images_dir |
+ String | +The directory where the images are kept.
+ It is relative to the project_path .
+ Defaults to "images" .
+ |
+
images_path |
+ String | +The full path to where images are kept.
+ Defaults to <project_path>/<images_dir> .
+ |
+
http_images_path |
+ String | +The full http path to images on the web server.
+ Defaults to http_path + "/" + images_dir .
+ |
+
javascripts_dir |
+ String | +The directory where the javascripts are kept.
+ It is relative to the project_path . Defaults to
+ "javascripts" .
+ |
+
javascripts_path |
+ String | +The full path to where javascripts are kept.
+ Defaults to <project_path>/<javascripts_dir> .
+ |
+
http_javascripts_path |
+ String | +The full http path to javascripts on the web server.
+ Defaults to http_path + "/" + javascripts_dir .
+ |
+
output_style |
+ Symbol | +The output style for the compiled css.
+ One of: :nested , :expanded , :compact ,
+ or :compressed .
+ |
+
relative_assets |
+ Boolean | +Indicates whether the compass helper functions + should generate relative urls from the generated css to assets, or absolute urls + using the http path for that asset type. + | +
additional_import_paths |
+ Array of Strings | +Other paths on your system from which to import
+ sass files. See the add_import_path function for a simpler
+ approach.
+ |
+
sass_options |
+ Hash | +These options are passed directly to the + Sass compiler. For more details on the format of sass options, please read the + sass options documentation. + | +
line_comments |
+ Boolean | +Indicates whether line comments should be added + to compiled css that says where the selectors were defined. Defaults to false + in production mode, true in development mode. + | +
preferred_syntax |
+ Symbol | +Can be :scss or :sass .
+ Defaults to :scss .
+ |
+