makon57/static-opdev

Running opdev.github.io

Fork and clone the repo:

1. fork opdev github pages repo

2. git clone from your forked repo

If you do not have ruby installed, follow these steps:

3. brew install chruby ruby-install

   • for Macs, followed these instructions install chruby & ruby

4. ruby-install ruby then exit terimal after installation

5. open new terminal and chruby 3.1.3

   • troublshoot by checking out ruby version: ruby -v

In opdev.github.io folder, run the steps below to live serve pages:

6. gem install jekyll bundler

Regenerate all gemspecs if needed:

7. gem pristine --all

Run live server:

8. jekyll serve -l

---

Submit an Article

1. Create Markdown style article

2. Add markdown file to _articles folder

3. run jekyll serve -l to build site & check that it all works and looks as desired

4. Add, commit, push, & create pull request

---

File structure breakdown

_includes : contain code snippets that are included in other files via the {% include footer.html %} tag

_layouts : contain the default html template structures of the entire site

_pages : contain static sites and will appear as opdev.github.io/static-site.html

_site : contains all sites and is autogenerated by jekyll and requires no intervention

_categories : contains an auto-generated MDs for individual categories contained in each article for easier organization and collection of articles into groups

_tags : contains an auto-generated MDs for tags contained in each article for easier organization and collection of articles, similar to categories but with more customization and specifics

_plugins : contain all extra ruby functionality for automated tasks like creating the MD files or filtering through tags & categories

assests : contain css, fonts, images,& js files