PyCon India Blog (https://in.pycon.org/blog/)
This repository holds the source code and related content for the official blog of PyCon India.
The blog is created using Pelican. You can get started with development by installing the requirements in a virtual environment.
- Create a virtual environment with virtualenv using
virtualenv <env_name>
. - Activate your virtual environment using
source /path-to-env/bin/activate
. - Run
pip install -r requirements.txt
to install all the dependencies for the blog. - Run
make serve
any time while working to start a development server.
The contents of the blog should be visible at http://localhost:8000/.
For further help, you can check out the Pelican docs.
Thank you for your you interest in contributing to PyCon India blog site, please read our Contribution Guidelines to get started. Submit an issue in the Issues section for reporting/fixing bugs and to request new features.
- Fork the repository and clone to your machine by using the command
git clone https://github.com/<username>/inpycon-blog.git
-
Follow the Getting Started guidelines to set-up the blog.
-
To run a local copy of the website, open the command prompt or your preferred CLI, change the directory to the address of the repository and use the command
make serve
to set up a development server. You can find a working copy of your work at http://localhost:8000/. -
To create a new blog, create a markdown file (.md) in the
content/blog
directory. For Pelican to parse the content properly, make sure the Metadata syntax at the start of your new blog is follows the pattern given below:
Title: Announcing X as Titanium Sponsor
Date: 2021-05-10 10:00
Category: 2021
Slug: announcing-X-as-titanium-sponsor
Summary: Short version for index and feeds
We are happy to introduce our Titanium sponsor **X**!
Blog content goes here in the following lines.
If you need any help with writing content in plecan, please check out the documentation.
- If you're wondering what to write in your commit messages, check out this guide on how to write good commit messages
- For a begineers guide on using Github, Visit Hello World-Github.
- For a guide to set up git for the first time, visit Setting up Git.
- For a detailed Git guide, you can read the book pro git.
- For markdown cheat sheet, click here.
For any more questions, please contact the admins of #content stream on the PyCon India Zulip.