Simple is simpliest jekyll theme.
Simple
is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem and related dependencies:
bundle install
To help anyone with any level of familiarity with Jekyll quickly get started, Simple
includes everything you need for a basic Jekyll site. To that end, just clone Simple and start up Jekyll.
git clone https://github.com/mrinjamul/simple-jekyll.git
To see your Jekyll site with Simple
applied, start a Jekyll server. In Terminal:
cd simple-jekyll
./tools/run
Open http://localhost:4000 in your browser, and voilà.
If you host your code on GitHub, you can use GitHub Pages to host your project.
gh-pages
branch.CNAME
file to point to your new domain.baseurl
in _config.yml
to point to your GitHub Pages URL. Example: for a repo at github.com/username/simple
, use http://username.github.io/simple/
. Be sure to include the trailing slash.
No matter your production or hosting setup, be sure to verify the baseurl
option file and CNAME
settings. Not applying this correctly can mean broken styles on your site.
Simple has two branches, but only one is used for active development.
main
for development. All pull requests should be to submitted against master
.
gh-pages
for our hosted site. Please avoid using this branch.
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in _sass/
, included into styles.scss
, and compile to styles.css
.
Open sourced under the MIT license.
Feel free to contribute.
Read guideline and start contributing.
Have questions or suggestions? Feel free to email us.