sculpin / blog-skeleton
A Skeleton for a Sculpin Based Blog
Installs: 2 790
Dependents: 0
Suggesters: 0
Security: 0
Stars: 83
Watchers: 11
Forks: 88
Open Issues: 33
Language:JavaScript
Type:sculpin-skeleton
Requires
- sculpin/sculpin: ^3.1
- dev-master
- 3.1.0.1
- 3.1.0.0
- 3.0.1.0
- 3.0.0.0
- 2.x-dev
- dev-dependabot/npm_and_yarn/json5-1.0.2
- dev-dependabot/npm_and_yarn/express-4.18.2
- dev-dependabot/npm_and_yarn/qs-6.5.3
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/composer/twig/twig-2.15.3
- dev-dependabot/composer/react/http-1.7.0
- dev-dependabot/npm_and_yarn/terser-4.8.1
- dev-dependabot/npm_and_yarn/eventsource-1.1.1
- dev-dependabot/npm_and_yarn/async-2.6.4
- dev-dependabot/npm_and_yarn/minimist-1.2.6
- dev-dependabot/npm_and_yarn/url-parse-1.5.10
- dev-dependabot/npm_and_yarn/follow-redirects-1.14.8
- dev-dependabot/npm_and_yarn/node-sass-7.0.0
- dev-dependabot/npm_and_yarn/path-parse-1.0.7
- dev-dependabot/npm_and_yarn/ws-6.2.2
- dev-dependabot/npm_and_yarn/dns-packet-1.3.4
- dev-dependabot/npm_and_yarn/browserslist-4.16.6
- dev-dependabot/npm_and_yarn/hosted-git-info-2.8.9
- dev-dependabot/npm_and_yarn/ssri-6.0.2
- dev-dependabot/npm_and_yarn/elliptic-6.5.4
- dev-dependabot/npm_and_yarn/ini-1.3.7
This package is auto-updated.
Last update: 2024-11-06 05:29:42 UTC
README
A skeleton for a Sculpin based blog.
Powered by Sculpin. =)
Features
A very basic Sculpin based blog supporting the following features:
- Very minimal Bootstrap based theme.
- A handful of existing posts in
source/_posts/
to get you started. Feel free to remove these when you are ready. - An about page at
/about
. - An index page at
/
. It displays all posts and paginates them. - A blog archive page at
/blog
. It displays post titles broken down by month and is paginated. - A blog categories page at
/blog/categories
. - A blog category index at
/blog/categories/$category
. Similar to the blog archive except broken down by each category. - A blog tags page at
/blog/tags
. - A blog tag index at
/blog/tags/$tag
. Similar to the blog archive except broken down by each tag.
Prerequisites
Sculpin is a PHP application and installed with the PHP package manager composer
.
See https://getcomposer.org/ for installation instructions.
Unless you do a very basic website, you want some CSS and Javascript assets. Sculpin
uses yarn
to manage them. See https://yarnpkg.com/en/docs/install for installation
instructions.
Install
Create a new project using composer:
$ composer create-project -s dev sculpin/blog-skeleton my-blog
This application uses Symfony's Webpack Encore to manage CSS, JavaScript and image assets. Install the JS dependencies:
$ cd my-blog
$ yarn install
Build
First, start Encore to compile and update the assets in source/assets/
into
source/build/
. The watcher keeps running until you exit it manually:
$ composer yarn-watch
In a new console, start the sculpin watcher to have your content updated as soon as you save changes:
$ composer sculpin-watch
Your newly generated clone of sculpin-blog-skeleton should now be accessible
at http://localhost:8000/
.
Documentation
The skeleton provides you with useful configuration and some example data for a Sculpin installation.
For more information about getting started with Sculpin, check out the Get Started page and have a look at the full documentation.