-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
Documentation of ignore/exclude/raw #11
Open
stevector
wants to merge
2
commits into
sculpin:master
Choose a base branch
from
stevector:master-documentation-of-ignore-exclude-raw
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
layout: default | ||
title: sculpin_kernel.yml | ||
|
||
--- | ||
|
||
# sculpin_kernel.yml | ||
|
||
Some parts of Sculpin, specifically anything configured as a bundle, must be | ||
configured at the kernel level. This can be done by modifying the | ||
`sculpin_kernel.yml` file. | ||
|
||
|-- app/ | ||
| `-- config/ | ||
| `-- sculpin_kernel.yml # Sculpin's configuration (optional) | ||
|
||
|
||
For example, to configure something like the default permalink for posts, one | ||
would need to configure the posts bundle's configuration: | ||
|
||
sculpin_posts: | ||
permalink: blog/:year/:month/:day/:filename/ | ||
|
||
Or if one wanted to change the default Markdown parser class, one would: | ||
|
||
sculpin_markdown: | ||
parser_class: Michelf\Markdown | ||
|
||
## Additional Examples | ||
|
||
Here is an incomplete list of of example overrides that can be done through sculpin_kernel.yml | ||
|
||
~~~ | ||
sculpin: | ||
# Paths marked as 'raw' are not processed by Sculpin at all and are copied | ||
# straight to the output directory. The "raw" designation is useful in case | ||
# something like compressed javascript or compressed css that would otherwise | ||
# be mangled. | ||
raw: | ||
- "path/to/raw/code" | ||
- "another/directory/of/raw/code" | ||
# Excluded files are not copied to the output directory yet still trigger | ||
# a rebuild out the output site. The Twig bundle adds the '_views' directory | ||
# to this list because these files do not need to be on a production website | ||
# yet changes to those files alter the output of the site. | ||
exclude: | ||
# Sass code doesn't need to be sent to the live server. | ||
- "code/_sass/" | ||
# @todo I don't know why the "*" is needed in this path to make the file | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If this is really the case then it is a bug. :-/ I'll see if I can reproduce this. |
||
# actually be excluded but it is. | ||
- "code/config.rb*" | ||
# Paths marked as "ignore" will be ignored by Sculpin and not copied to the | ||
# output directory. Unlike "exclude," changes to paths under "ignore" will not | ||
# trigger Sculpin rebuilds. | ||
ignore: | ||
- "ignore/this/directory" | ||
- "ignore/this/pattern_*" | ||
~~~ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is outdated, please see #70.