Skip to content

A Jamstack website to host Eko's independent documents and pages like help, FAQ, policies, etc.

License

Notifications You must be signed in to change notification settings

ekoindia/empages

Repository files navigation

Eko Docs

This repository hosts independent documents and pages for Eko, such as, help files, FAQ sections, public policy documents, etc.

Built with Jekyll Now

Jekyll is a static site generator that's perfect for GitHub hosted blogs (Jekyll Repository)

Jekyll Now makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup (Jekyll Now Repository).

  • You don't need to touch the command line
  • You don't need to install/configure ruby, rvm/rbenv, ruby gems ☺️
  • You don't need to install runtime dependencies like markdown processors, Pygments, etc

Quick Start

Step 1) Customize and view this site

Change site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild the site with jekyll. The rebuilt site will be viewable a few seconds later at https://ekoindia.github.io/empages - if not, give it ten minutes as GitHub suggests and it'll appear soon

There are 3 different ways that you can make changes to the blog's files:

  1. Edit files here within this repository in the browser at GitHub.com (shown below).
  2. Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
  3. Clone down this repository and make updates locally, then push them to GitHub.

_config.yml

Step 2) Publish the first blog post

Edit /_posts/2014-3-3-Hello-World.md to publish the first blog post. This Markdown Cheatsheet might come in handy.

First Post

You can add additional posts in the browser on GitHub.com too! Just hit the + icon in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md

Local Development

  1. Install Jekyll and plug-ins in one fell swoop. gem install github-pages This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
  2. Clone down your fork git clone https://github.com/yourusername/yourusername.github.io.git
  3. Serve the site and watch for markup/sass changes jekyll serve
  4. View your website at http://127.0.0.1:4000/
  5. Commit any changes and push everything to the master branch of this GitHub user repository. GitHub Pages will then rebuild and serve your website.

About

A Jamstack website to host Eko's independent documents and pages like help, FAQ, policies, etc.

Resources

License

Stars

Watchers

Forks