Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 2.51 KB

README.md

File metadata and controls

58 lines (47 loc) · 2.51 KB

The Python Nairobi Blog Repo

INTRO

This repository contains the sources used to build the python nairobi blog. We use pelican to build the contents of this repository into the site you see at http://blog.pynbo.or.ke or http://python-nairobi.github.io/pynbo-blog

PREREQUIESITES

To contribute, we recommend you install:-

CLONING

  1. Click here to fork this Repo.
  2. Clone your fork and cd into it.
  3. Create a virtualenv for your repo:- mkvirtualenv -a . pynbo-blog.
  4. Install the remaining dependencies:- pip install -r requirements.txt.
  5. Initialize & update submodule dependencies (plugins, theme & skulpt interpreter): git submodule update --init --recursive.
  6. Then create a branch, naming it along the lines as your topic of contribution.

EDITING

Start the development server:- ./develop_server.sh start. Open http://127.0.0.1:8000 to view. Any changes you make will automatically be reflected there.

MARKDOWN

Markdown, do you speak it? We write our articles in MarkDown from the content folder. Your markdown files should end with a .md, .markdown, or .mkd file extension. You should also include some metadata at the top of your markdown files. Checkout the example bellow and adapt appropriately:-

Title: Blog post title
Date: YYYY-MM-DD HH:MM
Tags: tag1, tag2
Category: Relevant_Category
Slug: short_descriptive_article_name
Author: Your Name (github_handle)
Summary: A summary of your blog post content
about_author: A brief summary about you
email: used to display your [gravar](https://gravatar.com/) in the article.

Blog Post Content Goes Here.

You can also cp content/article.md.template content/new_article.md and vi content/new_article.md appropriately. Feel free to write portions of your article in html to compensate for where markdown falls short e.g. opening links in new tabs. (Jules is ok with this)

FINALLY

  1. Add, commit and push your changes.
  2. Send us a pull request against master.

We'll review your contribution and maybe ask you to make further changes before we merge.