Skip to content

MashSoftware/strapyll

Repository files navigation

Strapyll

Build Status

Create and maintain beautiful, responsive, mobile-first websites and blogs with ease. Strapyll is a frontend toolkit that enables you to focus on creating content.

Strapyll integrates some of the most popular generation, templating, styling, testing, deployment, versioning and hosting solutions so you dont have to!

Made with Jekyll, Bootstrap, Bootswatch & Font Awesome.

Tested with HTML Proofer.

Deployed by Travis CI.

Prerequisites

Getting started

git clone [email protected]:MashSoftware/strapyll.git
cd strapyll
bundle install
bundle exec jekyll serve

Go to http://0.0.0.0:4000/

Adding pages

Place a new HTML file in the root directory and add following Front Matter YAML:

---
layout: navbar_footer
title: My New Page
permalink: /my-new-page/
---

Then go to http://0.0.0.0:4000/my-new-page/ to see the new blank page and start focussing on your content.

Running tests

This is the same script that Travis runs during the build, run this locally before pushing to avoid broken builds:

./script/cibuild

Deploying with Travis

travis enable
git commit -a -m "super awesome commit message"
git push

Next steps

Changing themes

Change the theme setting in _config.yml to any of the Bootswatch theme names and restart the server.

Changing layouts

There are two basic layouts included with Strapyll:

  • navbar_footer - a fixed navbar with a sticky footer.
  • navbar_sidebar - a fixed navbar with a sidebar.

Include either in your Front Matter layout element to use them.

Go to http://0.0.0.0:4000/navbar-footer/ or http://0.0.0.0:4000/navbar-sidebar/ to preview them.

Making new layouts

The _includes directory contains all the partial HTML needed to construct a new layout.

Place your {% include <example>.html %} tags within your templated HTML in the _layouts directory. The {% include head.html %} and {% include scripts.html %} includes are required to use Bootstrap, Bootswatch and Font Awesome, or replace them with your own.

Everything else

Please refer to the documentation for the various components used:

About

Frontend toolkit that enables you to focus on creating content.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published