An open API service indexing awesome lists of open source software.

https://github.com/pythonindia/inpycon-blog

PyCon India Blog
https://github.com/pythonindia/inpycon-blog

Last synced: about 1 year ago
JSON representation

PyCon India Blog

Awesome Lists containing this project

README

          

# Inpycon Blog

PyCon India Blog (https://in.pycon.org/blog/)

This repository holds the source code and related content for the official blog of [PyCon India](https://in.pycon.org/).

## Getting Started

The blog is created using Pelican. You can get started with development by installing the requirements in a virtual environment.

1. Create a virtual environment with [virtualenv](https://virtualenv.pypa.io/en/stable/) using `virtualenv `.
2. Activate your virtual environment using `source /path-to-env/bin/activate`.
3. Run `pip install -r requirements.txt` to install all the dependencies for the blog.
4. Run `make serve` any time while working to start a development server.

The contents of the blog should be visible at [http://localhost:8000/](http://localhost:8000/).

For further help, you can check out the [Pelican docs](https://docs.getpelican.com/en/stable/index.html).

## Want to Contribute?

Thank you for your you interest in contributing to PyCon India blog site, please read our [Contribution Guidelines](CONTRIBUTING.md) to get started. Submit an issue in the Issues section for reporting/fixing bugs and to request new features.

### instructions for Writers

1. Fork the repository and clone to your machine by using the command
```
git clone https://github.com//inpycon-blog.git
```
2. Follow the [Getting Started](#getting-started) guidelines to set-up the blog.

3. 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/](http://localhost:8000/).

4. 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](https://docs.getpelican.com/en/stable/content.html).

## Instructions for First-Time Contributors

1) If you're wondering what to write in your commit messages, check out this guide on [how to write good commit messages](https://chris.beams.io/posts/git-commit/)
2) For a begineers guide on using Github, Visit [Hello World-Github](https://guides.github.com/activities/hello-world/).
3) For a guide to set up git for the first time, visit [Setting up Git](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup).
4) For a detailed Git guide, you can read the book [pro git](https://git-scm.com/book/en/v2).
5) For markdown cheat sheet, [click here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code).

For any more questions, please contact the admins of [#content](https://pyconindia.zulipchat.com/#narrow/stream/246476-wg.2Fcontent) stream on the [PyCon India Zulip](https://pyconindia.zulipchat.com/).