README.md

Chicago Python Algorithms Special Interest Group

Algo SIG is a subgroup of ChiPy, the Chicago Python Users Group.

How to add new content

This site is designed for GitHub Pages, which is built with Jekyll. No local setup is required.

1. Fork the repository
2. Create or edit a markdown file in the _posts folder. See existing posts for header variables to include.
3. Submit a pull request. Upon approval, your changes will be added the hosted website.

Local Development

In order to make changes to the website design or archictecture and preview the website on a local server, you will need a local development environment. Follow these steps.

Install Jekyll and Ruby

Follow the appropriate guide for your system. Specific notes for Windows are provided here.

Windows 10 with WSL

1. Install WSL and Ubuntu from the Microsoft Store
2. Follow the WSL Jekyll installation guide

   • If you receive a permission error at gem update or gem install jekyll bundler, read Running Jekyll as Non-Superuser (no sudo!)

   • Modify your .bashrc in your Ubuntu user directory:

     nano ~/.bashrc

   • Add the following lines :

     # Ruby exports
     
     export GEM_HOME=$HOME/gems
     export PATH=$HOME/gems/bin:$PATH
     

     Restart the terminal, or reload .bashrc:

     . ~/.bashrc

   • Resume the WSL Jekyll installation guide.

Install Jekyll Dependencies

With Jekyll installed, you now need to install the dependencies for this particular website.

Install dependencies specified in this repo's Gemfile and Gemfile.lock

bundle install

• On WSL, you may need to issue the following commands prior to bundle install. See this guide.

  sudo apt-get install libpng-dev
  sudo apt-get install --reinstall zlibc zlib1g zlib1g-dev
  

Run the Server

bundle exec jekyll serve --future

Miscellaneous

• Syntax styling/highlighting theme for code blocks was set via:

  rougify style github > assets/syntax.css
  

Theme Credits

Boostrap with Bootswatch theme.