{"id":18606047,"url":"https://github.com/website-templates/jekyll-inclusion","last_synced_at":"2025-04-10T20:31:26.157Z","repository":{"id":25925216,"uuid":"29366371","full_name":"website-templates/jekyll-inclusion","owner":"website-templates","description":"Grunt powered Jekyll blog theme based on Inclusion framework (Sass, Jade, Coffee)","archived":false,"fork":false,"pushed_at":"2022-10-06T06:33:28.000Z","size":13810,"stargazers_count":37,"open_issues_count":11,"forks_count":49,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-25T04:13:21.231Z","etag":null,"topics":["css3","grunt","html5","jekyll","jekyll-blog-theme","liquid","pug","responsive","sass","template","theme","yaml"],"latest_commit_sha":null,"homepage":"http://website-templates.github.io/jekyll-inclusion/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"embeddedarm/linux-3.0.35","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/website-templates.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-16T20:25:41.000Z","updated_at":"2024-12-05T12:24:08.000Z","dependencies_parsed_at":"2023-01-14T09:30:17.010Z","dependency_job_id":null,"html_url":"https://github.com/website-templates/jekyll-inclusion","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/website-templates%2Fjekyll-inclusion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/website-templates%2Fjekyll-inclusion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/website-templates%2Fjekyll-inclusion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/website-templates%2Fjekyll-inclusion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/website-templates","download_url":"https://codeload.github.com/website-templates/jekyll-inclusion/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248290033,"owners_count":21078923,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css3","grunt","html5","jekyll","jekyll-blog-theme","liquid","pug","responsive","sass","template","theme","yaml"],"created_at":"2024-11-07T02:24:05.748Z","updated_at":"2025-04-10T20:31:24.781Z","avatar_url":"https://github.com/website-templates.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll blog theme\n\nSimple and nice blog theme based on Inclusion framework.\n\nProudly built with [Jekyll](http://jekyllrb.com/) and [Grunt](http://gruntjs.com/), hosted on [Github](https://github.com).\nCompatible browsers: IE8+, Firefox, Chrome, Opera, Yandex.browser, Safari\n\nCheck out [quick demo](http://website-templates.github.io/jekyll-inclusion/) of this theme\n\n---\n\n##Contents\n* [Requirements](#requirements)\n* [Structure](#structure)\n* [Development and blogging](#development-and-blogging)\n\t- [Editorconfig](#editorconfig)\n\t- [Grunt tasks](#grunt-tasks)\n\t- [Data driven nav](#data-driven-nav)\n\t- [Post creation](#post-creation)\n* [Changelog](#changelog)\n* [Credits](#credits)\n* [License](#license)\n\n## Requirements:\n\n- [Ruby](http://www.ruby-lang.org/)\n- [Node.js](http://nodejs.org/)\n- [Grunt](http://gruntjs.com/) (`npm install -g grunt-cli`)\n- [Bower](http://bower.io/) (`npm install -g bower`)\n- [Python](http://www.python.org/) with [pip](http://www.pip-installer.org/)\n\n## Structure\nThere are two branches: master branch and gh-pages. Master is a main develop branch.\nProject based on [Synteagle general project template](https://github.com/synteagle/se-general-template)\n```\n./\n├── .editorconfig\n├── Gruntfile.js\n├── package.json\n├── bower.json\n├── README.md\n├── CHANGELOG.md\n├── Rakefile\n├── Gemfile\n├── _config.yml\n├── post.sh\n├──grunt/                                      * grunt tasks\n|   ├── task.js\n│   └── aliases.yml \n|\n├── dev/                                       * site source\n|   ├── coffee/                                * coffee scripts\n|\t│   └── main/                              * main scripts\n|\t│\n│   ├── images/                                * image sources\n|\t│\n│   ├── jade/                                  * templates\n|\t|\t├── blocks/                            * blocks library\n|\t│   |   └── block.jade\n|\t│   ├── helpers/                           * helper mixins\n|\t│   ├── vendor/                            * third-party code\n|\t│   ├── layouts/                           * page layouts\n|\t│   └── pages/                             * main pages templates\n|\t│\n│   ├── js/                                    * compiled and source js\n|\t|   ├── main/                              * main site scripts\n|\t│   ├── ie/                                * ie compat scripts\n|\t│   └── vendor/                            * vendor scripts\n|\t│\n|\t├── sass/                                  * sass preprocessor styles\n|\t|\t├── blocks/                            * blocks library\n|\t│   |   └── block.sass\n|\t│   ├── helpers/                           * mixins and vars\n|\t│   ├── vendor/                            * third-party code\n|\t│   └── screen.sass\n|\t│\n│   ├── ruby/                                  * jekyll plugins\n|\t│\n│   ├── helpers/                               * helper files\n|\t│\n│   ├── fonts/                                 * font sources\n|\t│\n│   └── devtools/                              * some dev tools\n│\n├── build/                                     * built source\n|\t├── index.html\n|\t├── _data/                                 * jekyll data (i18n, locales)\n|\t|\n|\t├── _drafts/                               * drafts\n|\t|\n|\t├── _layouts/                              * layouts for jekyll generation\n|\t|\n|\t├── _plugins/                              * jekyll plugins\n|\t|\n|\t├── _posts/                                * posts (*.md)\n|\t|\n|\t└── static/                                * static assets\n|\t\t├── css/                               * minified styles\n|\t\t|\n|\t\t├── images/                            * minified images\n|\t\t│\n|\t\t├── js/                                * minified assembled js\n|\t\t|\n|\t\t└── fonts/                             * @font-face-ready webfonts\n│\n└── publ/                                      * generated website\n\t├── _data/                                 * jekyll data (i18n, locales)\n\t|\n\t├── _drafts/                               * drafts\n\t|\n\t├── _posts/                                * posts (*.md)\n\t|\n\t└── static/                                * static assets\n\t\t└── images/                            * post and pages images\n\n```\n\nTake a look at [this article](http://www.aymerick.com/2014/07/22/jekyll-github-pages-bower-bootstrap.html) about creating dev and deploy branches for your blog. \n\nNOTE: this example use in _config.yml use baseurl option, so after domain there is path: /jekyll-inclusion. If you want to run this example on the local machine you should comment or remove this line in _config.yml file.\n\n## Development and blogging\n\n### Editorconfig\nThis project contains .editorconfig file. It describes codestyle like indentation, trailing whitespaces etc. See more details [here](http://editorconfig.org/) \n\n### Grunt tasks\nHere comes groups of grunt tasks with some explanations\n\n#### Start \n`grunt start` - Install bower dependencies and place them to dev folders\n```\n- 'shell:bower'                          Install bower components\n- 'bower:ie'                             Copy ie components to js folder\n- 'bower:vendor'                         Copy vendor  components to js folder\n```\n\n#### Dev\n`gulp dev` - Dev task with static server\n```\n- 'coffee:main'                          Compile main coffescripts\n- 'concat:main'                          Concatenate main javascripts\n- 'concat:ie'                            Concatenate ie javascripts\n- 'concat:vendor'                        Concatenate vendor javascripts\n- 'sass'                                 Compile Sass stylesheets\n- 'jade'                                 Compile Jade templates\n- 'sync:imagesDev'                       Sync images\n- 'sync:fontsDev'                        Sync fonts\n- 'sync:helpersDev'                      Sync helpers and other assets\n- 'sync:rubyDev'                         Sync jekyll plugins\n- 'sync:mainPubl'                        Sync posts and pages from publ folder\n- 'shell:jekyllBuild'                    Generate site using Jekyll.rb\n- 'browserSync:dev'                      Run dev server with watch option\n- 'watch:dev'                            Watch for changes and run dev task\n```\n\n#### Build \n`grunt build` - Build task\n```\n- 'shell:jekyllBuild'                    Generate site using Jekyll.rb\n- 'imagemin'                             Minify images\n- 'cmq'                                  Combine media queries in css files\n- 'autoprefixer'                         Add vendor prefixes in css\n- 'csscomb'                              Applie styleguide to stylesheets\n- 'uglify'                               Minify javascript files\n- 'csso'                                 Minify stylesheets\n- 'processhtml'                          Replace assets paths in html\n- 'htmlmin'                              Minify html\n- 'clean:dev'                            Remove dev things\n- 'browserSync:test'                     Run test server without watch\n```\n\n#### Rebuild \n`grunt rebuild` - Regenerate and build project by running all tasks\n```\n- 'coffee:main'                          Compile main coffescripts\n- 'concat:main'                          Concatenate main javascripts\n- 'concat:ie'                            Concatenate ie javascripts\n- 'concat:vendor'                        Concatenate vendor javascripts\n- 'sass'                                 Compile Sass stylesheets\n- 'jade'                                 Compile Jade templates\n- 'sync:imagesDev'                       Sync images\n- 'sync:fontsDev'                        Sync fonts\n- 'sync:helpersDev'                      Sync helpers and other assets\n- 'sync:rubyDev'                         Sync jekyll plugins\n- 'sync:mainPubl'                        Sync posts and pages from publ folder\n- 'shell:jekyllBuild'                    Generate site using Jekyll.rb\n- 'imagemin'                             Minify images\n- 'cmq'                                  Combine media queries in css files\n- 'autoprefixer'                         Add vendor prefixes in css\n- 'csscomb'                              Applie styleguide to stylesheets\n- 'uglify'                               Minify javascript files\n- 'csso'                                 Minify stylesheets\n- 'processhtml'                          Replace assets paths in html\n- 'htmlmin'                              Minify html\n- 'clean:dev'                            Remove dev things\n```\n\n#### Theme\n`grunt theme` - Theme styles and scripts fixing\n```\n- 'coffee:main'                          Compile main coffescripts\n- 'concat:main'                          Concatenate main javascripts\n- 'concat:ie'                            Concatenate ie javascripts\n- 'concat:vendor'                        Concatenate vendor javascripts\n- 'sass'                                 Compile Sass stylesheets\n- 'sync:cssTheme'                        Sync css with Jekyll generated assets\n- 'sync:jsTheme'                         Sync js with Jekyll generated assets\n- 'browserSync:theme'                    Run dev server with watch option\n- 'watch:theme'                          Watch for changes and run theme task\n```\n\n#### Template\n`grunt template` - Theme templates fixing\n```\n- 'jade'                                 Compile Jade templates\n- 'shell:jekyllBuild'                    Generate site using Jekyll.rb\n```\n\n#### Publish\n`grunt publish` - Copy posts, pages and images and generates website\n```\n- 'sync:mainPubl'                        Copy posts, pages and images\n- 'shell:jekyllBuild'                    Generate site using Jekyll.rb\n- 'processhtml'                          Replace assets paths in html\n- 'htmlmin'                              Minify html\n- 'clean:dev'                            Remove dev things\n```\n\n#### Deploy \n`grunt deploy` - Deploy project by running Rakefile: git or ftp push\n```\n- 'shell:deploy'                         Deploy generated site to gh-pahes\n```\n\n#### Server \n`grunt server` - Run server without watching for changes\n```\n- 'browserSync:test'                     Run test server without watch\n```\n\n### Data driven nav\nThis theme use special data from _data/nav.yml to generate navigation. It's useful when you need to create nested menu. Also each page have menu option and if it will turn to true - this page will appear in menu.\n\n### Post creation\nThere is a [simple bash script](https://gist.github.com/orlovmax/f1b73a5fd01fc4b917c2) that allows us to create new posts. I've put it in the root of the website, so just execute it, like `bash post.sh your-post-name` or `post.sh your-post-name` and it will create new *.md file at `_publ/pages/_posts` with predefined draft layout from `_draft` directory and also it will create folder in `_publ/img/posts/` with name `your-post-name` for your post images. It's pretty simple and useful.\n\n## Changelog\nYouc can find full changelog [HERE](https://github.com/website-templates/jekyll-inclusion/blob/master/CHANGELOG.md)\n\n## Credits\n* [JADE bemto mixin](https://github.com/kizu/bemto)\n* [Lazy load plugin](http://www.appelsiini.net/projects/lazyload)\n* [Intense Image Viewer](http://tholman.com/intense-images/)\n* [Prism syntax highlighter](http://prismjs.com/download.html) \n* [Detect Mobile Browsers](http://detectmobilebrowsers.com/)\n* [Clean blog jekyll theme](https://github.com/IronSummitMedia/startbootstrap-clean-blog-jekyll)\n* [Strip.rb - strip newlines after for loop](https://github.com/aucor/jekyll-plugins)\n* [Tag pages generator](https://github.com/ilyakhokhryakov/jekyll-tagging-pagination)\n* [Tag and Category pages pagination](https://github.com/realjenius/realjenius.com/blob/master/_plugins/cat_and_tag_generator.rb)\n* [Jekyll i18n filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb)\n\n## License\n[MIT](http://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsite-templates%2Fjekyll-inclusion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebsite-templates%2Fjekyll-inclusion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsite-templates%2Fjekyll-inclusion/lists"}