Skip to content

cli specific docs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 19, 2016
Merged

cli specific docs #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4b16d7
cli specific docs
kylemac May 18, 2016
5f6c0d6
remove cli-only opts in app.js section of readme
kylemac May 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,12 @@ You can configure your spike projects through a single config file at the root,

Option | Description | Default
:--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------
**root** | **[required]** An absolute path to the root of your project. |
**matchers** | An object with `jade`, `css`, and `js` keys. Each key is a [micromatch](https://github.com/jonschlinkert/micromatch) string, and represents which files should be pulled into the pipeline to be processed. Be very careful if you are trying to change this. | `**/*.jade`, `**/*.css`, and `**/*.js`
**postcss** | An object that can contain a `plugins` key, which is an array of [plugins to be passed to PostCSS](http://postcss.parts/) for CSS processing, and a `parser`, `stringifier`, and/or `syntax` key, each of which are objects and take [any of the postcss-loader options](https://github.com/postcss/postcss-loader#custom-syntaxes) |
**babel** | A [configuration object for Babel](http://babeljs.io/docs/usage/options/) for JS processing. |
**jade** | A [configuration object for jade](http://jade-lang.com/api/). |
**dumpDirs** | An array of directories which, if direct children of the project root, will dump their contents to the root on compile. | `['views', 'assets']`.
**locals** | An object containing locals to be passed to jade views. This can be used for values, functions, any sort of view helper you need. |
**env** | The environment you would like to use when compiling. See [environments](#environments) for more information about this option. |
**ignore** | An array of [micromatch](https://github.com/jonschlinkert/micromatch) strings, each one defining a file pattern to be ignored from compilation. |
**outputDir** | The name or path of the folder your project will be compiled into, on top of the project's root. | `'public'`
**cleanUrls** | Remove `.html` from your paths during `spike.watch`. | `true`
Expand Down