init

.gitignore

@@ -0,0 +1,2 @@
+/output_*/
+/vendor/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Oliver Davies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,50 @@
+# Sculpin Skeleton
+
+A skeleton project for the [Sculpin][1] static site generator.
+
+## Usage
+
+1. Download the project by running `composer create-project opdavies/sculpin-skeleton --no-interaction --no-progress --prefer-dist my-sculpin-site`.
+1. Run `cd my-sculpin-site` to change into the project directory, and `composer run watch` to generate and serve the site.
+1. Start adding content to `source/index.md`.
+1. Add more content, settings, layouts, includes etc as needed.
+
+## Scripts
+
+This project includes some custom Composer scripts that you can use rather than running `vendor/bin/sculpin` directly, and that include some additional default options.
+
+These are:
+
+- `composer run generate` and `composer run dev` - These generate the site in the development mode.
+- `composer run watch` - Generates and serves the site in development mode, watching for any changes.
+- `composer run prod` - Generates the site in production mode.
+
+You can still pass additional options by separating the command and options with `--`. For example, running `composer run watch -- --port=8002` would run the default watch command but also update the server port:
+
+```
+composer run watch -- --port=8002
+> composer run generate -- --server --watch '--port=8002'
+> sculpin generate --clean --no-interaction '--server' '--watch' '--port=8002'
+Deleting /Users/opdavies/Code/Personal/sculpin-skeleton/output_dev
+Detected new or updated files
+Generating: 100% (1 sources / 0.00 seconds)
+Converting: 100% (1 sources / 0.20 seconds)
+Formatting: 100% (1 sources / 0.00 seconds)
+Processing completed in 0.27 seconds
+Starting Sculpin server for the dev environment with debug true
+Development server is running at http://localhost:8002
+Quit the server with CONTROL-C.
+```
+
+## Notes
+
+- The `posts` content type is disabled by default. Re-enable it if needed by removing `enabled: false` from `app/config/sculpin_kernel.yml`.
+
+[1]: https://sculpin.io
+[2]: https://getcomposer.org/doc/06-config.md#process-timeout
+
+## License
+
+[MIT][0]
+
+[0]: https://github.com/opdavies/sculpin-skeleton/blob/master/LICENSE

app/config/sculpin_kernel.yml

@@ -0,0 +1,3 @@
+sculpin_content_types:
+    posts:
+        enabled: false

app/config/sculpin_site.yml

@@ -0,0 +1 @@
+title: 'My New Sculpin Site'

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "opdavies/sculpin-skeleton",
+    "description": "A skeleton Sculpin site.",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Oliver Davies",
+            "email": "oliver@oliverdavies.uk",
+            "homepage": "https://www.oliverdavies.uk"
+        }
+    ],
+    "require": {
+        "dflydev/embedded-composer": "^1.0@dev",
+        "sculpin/sculpin": "^2.1@dev"
+    },
+    "scripts": {
+        "dev": "composer run-script generate",
+        "generate": "sculpin generate --clean --no-interaction",
+        "prod": "composer run-script generate -- --env prod",
+        "watch": "composer run-script --timeout=0 generate -- --server --watch"
+    }
+}

source/_layouts/default.html.twig

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <title>{{ site.title }}</title>
+    </head>
+    <body>
+        {% block content %}{% endblock %}  
+    </body>
+</html>

source/index.md

@@ -0,0 +1,4 @@
+---
+layout: default
+---
+Hello, World!