README.md

Industry Python Blog

Free Python Course

A Quarto-based blog for Industry Python content.

IMPORTANT: Contribution steps were written for Oppkey staff. If you are a community contributor or volunteer, you must follow a different process. We are making a video on how to make a pull request from a fork. Content jcasman@oppkey.com for more information.

Adding a New Blog Post for Staff with write access to repo

NOTE: if you are a volunteer or member of the community without write access, you must make a fork and make a pull request from that fork.

To add a new blog post, follow these steps:

1. Create a New Post Directory

Create a new directory in the posts/ folder with a descriptive name (use kebab-case):

mkdir posts/your-post-name

2. Create the Post File

Create an index.qmd file in your new directory:

touch posts/your-post-name/index.qmd

3. Add Post Content

Open posts/your-post-name/index.qmd and add your content with the required YAML frontmatter:

---
title: "Your Post Title"
author: "Your Name"
date: "YYYY-MM-DD"
categories: [category1, category2]
---

Your post content goes here. You can use:

- **Markdown** for formatting
- Code blocks for examples
- Images (see below)
- Any Quarto features

4. Add Call-to-Action (Required)

Every blog post must include a call-to-action (CTA) linking back to the free Python course. Add this at the end of your post content:

---

[Free Python Course](https://industry-python.thinkific.com/products/courses/industry-projects-with-python)

5. Add Images and Assets (Optional)

If your post includes images or other assets, place them in the same directory as your index.qmd file:

posts/your-post-name/
  ├── index.qmd
  ├── image1.png
  └── thumbnail.jpg

Reference images in your post using relative paths:

![](image1.png)

6. Preview Locally

NOTE: to preview locally, you must have Quarto installed on your local computer.

To preview your blog locally, run:

quarto preview

This will start a local server where you can view your blog and see your new post.

7. Build and Deploy

When you're ready to publish:

1. Commit your changes:

git add posts/your-post-name/
git commit -m "Add new post: Your Post Title"

1. Push to GitHub:

NOTE: you will not be able to push to the upstream repo unless you have write access to it. You must push to your own fork and then make a pull request.

git push

1. Automatic Deployment:

The GitHub Action will automatically build and deploy your site to GitHub Pages. You can check the deployment status in the Actions tab of your GitHub repository.

Post Frontmatter Options

The YAML frontmatter supports these fields:

• title (required): The title of your blog post
• author (required): The author's name
• date (required): Publication date in YYYY-MM-DD format
• categories: Array of category names (e.g., [news, tutorial, python])

Project Structure

industry-python-blog/
├── posts/
│   ├── _metadata.yml          # Settings applied to all posts
│   ├── welcome/
│   │   ├── index.qmd          # Post content
│   │   └── images/            # Post assets
│   └── your-post-name/
│       └── index.qmd
├── _quarto.yml                # Quarto configuration
├── index.qmd                  # Blog homepage
└── about.qmd                  # About page

Development

Local Development

1. Install Quarto: https://quarto.org/docs/get-started/

2. Preview the site:

quarto preview

1. Build the site:

quarto render

The built site will be in the _site/ directory (ignored by git).

GitHub Pages

The site is automatically built and deployed via GitHub Actions when you push to the main or master branch. The workflow:

1. Builds the Quarto site
2. Deploys it to GitHub Pages

No manual deployment needed!

Resources

• Quarto Documentation
• Quarto Blog Format

VSCode or Cursor Extensions