Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/franzscholz/jekyll-theme-html5up-landed

A port of the HTML5UP Landed theme to Jekyll.
https://github.com/franzscholz/jekyll-theme-html5up-landed

jekyll jekyll-theme

Last synced: about 2 months ago
JSON representation

A port of the HTML5UP Landed theme to Jekyll.

Awesome Lists containing this project

README 

        
# html5up-landed



Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.



To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!



TODO: Delete this and the text above, and describe your gem



## Installation



Add this line to your Jekyll site's `Gemfile`:



```ruby

gem "jekyll-theme-html5up-landed"

```



And add this line to your Jekyll site's `_config.yml`:



```yaml

theme: jekyll-theme-html5up-landed

```



And then execute:



    $ bundle



Or install it yourself as:



    $ gem install jekyll-theme-html5up-landed



## Usage



TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.



## Contributing



Bug reports and pull requests are welcome on GitHub at https://github.com/franzscholz/jekyll-theme-html5up-landed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.



## Development



To set up your environment to develop this theme, run `bundle install`.



Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.



When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.

To add a custom directory to your theme-gem, please edit the regexp in `html5up-landed.gemspec` accordingly.



## License



The theme is available under the terms of the original [HTML5U License](https://html5up.net/license), i.e. the

[Creative Commons CC BY 3.0 License](https://creativecommons.org/licenses/by/3.0/).



The original README.txt is as follows:



    Landed by HTML5 UP

    html5up.net | @ajlkn

    Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)



    A dark, slick, modern, responsive, adjective-drenched design built around an extremely

    dynamic landing page (scroll that mofo!). Inspired by Big Picture, another design

    of mine with a similarish feel/flow, only this time I took it waaaaaay further and

    actually made it multipurpose (versus copping out and making it a one pager like I

    did last time ;) Includes multiple pages, a bunch of pre-styled elements, and all

    its Sass sources.



    Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images

    you can use for pretty much whatever.



    (* = Not included)



    Feedback, bug reports, and comments are not only welcome, but strongly encouraged :)



    AJ

    [email protected] | @ajlkn



    Credits:



        Demo Images:

            Unsplash (unsplash.com)



        Icons:

            Font Awesome (fontawesome.io)



        Other:

            jQuery (jquery.com)

            Scrollex (github.com/ajlkn/jquery.scrollex)

            Responsive Tools (github.com/ajlkn/responsive-tools)