Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mavimo/sculpin-projects-bundle
Sculpin Projects Bundle
https://github.com/mavimo/sculpin-projects-bundle
Last synced: about 2 months ago
JSON representation
Sculpin Projects Bundle
- Host: GitHub
- URL: https://github.com/mavimo/sculpin-projects-bundle
- Owner: mavimo
- License: mit
- Created: 2013-12-26T15:00:01.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-01-02T17:58:09.000Z (about 11 years ago)
- Last Synced: 2024-12-01T04:52:13.061Z (2 months ago)
- Language: PHP
- Size: 137 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sculpin Projects Bundle
## Setup
Add this bundle in your ```sculpin.json``` file:
```json
{
// ...
"require": {
// ...
"mavimo/sculpin-projects-bundle": "@dev"
}
}
```
and install this bundle running ```sculpin update```.
Now you can register the bundle in ```SculpinKernel``` class available on ```app/SculpinKernel.php``` file:
```php
class SculpinKernel extends \Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel
{
protected function getAdditionalSculpinBundles()
{
return array(
'Mavimo\Sculpin\Bundle\ProjectsBundle\SculpinProjectsBundle'
);
}
}
```
## How to use
In your sources create a subfolder *_projects* and add some file inside it, like:
```
my-blog/
└── source
├── // ...
└── _projects
├── 2014-01-01-my-new-project.md
├── 2014-01-02-another-project.md
└── 2014-01-03-more-projects.md
```
create the required template files, and get the list of projects using in document metadata to have the paginated list of projects:
```
---
title: Projects
// ...
generator: pagination
pagination:
provider: data.projects
// ...
---
```