/sz-jekyll-flex

Jekyll 3.3 Qk/Quik Start (https://github.com/quikstart) Starter template / scaffold

Primary LanguageCSS

Jekyll 3.3 Qk/Quik Start โšก Starter template / scaffold

๐Ÿ”ฎ Live preview (gh-pages)

Features

  • 2 columns
  • sass boilerplate 1-7
  • normalize v.5.0.0
  • flexbox layout (mobile first)
  • toggle aside without JS

Usage

  • GH-Pages

    Fork repo, remove master branch and customize config.yml + /assets/css/style.scss with your site settings.

  • QK/Quik

    Install QK/Quik gem:

    ~ $ gem install quik
    

    Use like:

    ~ $ quik new sz-jekyll-flex
    

    This will download and run the sz-jekyll-flex.rb quik starter script:

    starting new Quik script {}; lets go
    Hello from the sz-jekyll-flex template
    Q: Name of the template? [blog]:
    

    Type your project name or push intro to use default name "blog":

    handle install_template StartZeroGnu/sz-jekyll-flex, {}
    

    Resulting in:

    <project-name>
    โ”œโ”€โ”€ assets
    โ”‚   โ””โ”€โ”€ css
    โ”‚       โ””โ”€โ”€ style.scss
    โ”œโ”€โ”€ _includes
    โ”‚   โ”œโ”€โ”€ burguer.html
    โ”‚   โ”œโ”€โ”€ disqus_comments.html
    โ”‚   โ”œโ”€โ”€ footer.html
    โ”‚   โ”œโ”€โ”€ google-analytics.html
    โ”‚   โ”œโ”€โ”€ head.html
    โ”‚   โ”œโ”€โ”€ nav.html
    โ”‚   โ””โ”€โ”€ title.html
    โ”œโ”€โ”€ _layouts
    โ”‚   โ”œโ”€โ”€ default.html
    โ”‚   โ”œโ”€โ”€ page.html
    โ”‚   โ””โ”€โ”€ post.html
    โ”œโ”€โ”€ _posts
    โ”‚   โ””โ”€โ”€ YYYY-MM-DD-my-example-post.md
    โ”œโ”€โ”€ _sass
    โ”‚   โ”œโ”€โ”€ abstracts
    โ”‚   โ”‚   โ”œโ”€โ”€ _functions.scss
    โ”‚   โ”‚   โ”œโ”€โ”€ _mixins.scss
    โ”‚   โ”‚   โ””โ”€โ”€ _variables.scss
    โ”‚   โ”œโ”€โ”€ base
    โ”‚   โ”‚   โ”œโ”€โ”€ _base.scss
    โ”‚   โ”‚   โ”œโ”€โ”€ _fonts.scss
    โ”‚   โ”‚   โ”œโ”€โ”€ _helpers.scss
    โ”‚   โ”‚   โ””โ”€โ”€ _typography.scss
    โ”‚   โ”œโ”€โ”€ components
    โ”‚   โ”‚   โ”œโ”€โ”€ _button.scss
    โ”‚   โ”‚   โ””โ”€โ”€ _icon.scss
    โ”‚   โ”œโ”€โ”€ layout
    โ”‚   โ”‚   โ””โ”€โ”€ _main.scss
    โ”‚   โ”œโ”€โ”€ pages
    โ”‚   โ”‚   โ””โ”€โ”€ _home.scss
    โ”‚   โ”œโ”€โ”€ themes
    โ”‚   โ”‚   โ””โ”€โ”€ _default.scss
    โ”‚   โ”œโ”€โ”€ vendor
    โ”‚   โ”‚   โ”œโ”€โ”€ _normalize.scss
    โ”‚   โ”‚   โ””โ”€โ”€ _syntax-highlighting.scss
    โ”‚   โ””โ”€โ”€ style.scss
    โ”œโ”€โ”€ _config.yml
    โ”œโ”€โ”€ .gitignore
    โ”œโ”€โ”€ about.md
    โ”œโ”€โ”€ Gemfile
    โ”œโ”€โ”€ index.html
    โ”œโ”€โ”€ LICENSE.txt
    โ””โ”€โ”€ README.md
    

    Now run Jekyll serve for a quick view:

    ~ $ bundle exec jekyll s
    

    Dance ๐ŸŽต and celebrate ๐ŸŽ‰

Credits and Thanks ๐Ÿ‘

Contributing

Bug reports and pull requests are welcome.

License

Script Public domain license ยท Template MIT license.