This repository contains the code and source content that powers northseattle.dev - a website for North Seattle Tech Talks and Open Source Hackathons. This project is made possible by the contributions of many contributors.

Adding Content

Put new content in the content directory. By default, new content is added as an additional article on the site. If the content is intended to render as a new tab at the top of the site, place it in the content/pages sub-directory. This content should follow the markdown standard and be placed in .md files. These markdown files should have all lower-case file names, separating words by _. You can test the formatting before submitting a pull-request to the project using an online interactive markdown previewer, or by setting the project up locally as detailed below. Above the markdown content there is also a collection of meta-data that can be applied to change where and how the content renders, and give credit to the original author. For Example:

Title: Code of Conduct
Date: 2019-02-25
Author: Clark Winters
Tags: information, teamwork
save_as: codeofconduct.html

The most important meta-data parameters to set are: Title, Date, and Author. See: Pelican's content article for more information. For a complete guide to contributing to the website see: CONTRIBUTING.md. Once the content is added to the master branch it will automatically be deployed to the website via CI/CD, so be careful what you merge into this branch!

Initial setup for development locally

1. Install Git on your machine

   • Windows
   • Linux
   • MacOS

2. Install Python3 on your machine

   • Linux
   • MacOS
   • Windows

     • NOTE: Make sure you check the box that says "Add Python 3.x to PATH" during installation. If you fail to do this:

       1. Re-run the install executable
       2. Click "Modify"
       3. Select 'Add Python to environment variables' on the second screen
       4. Click "Install"

3. Fork repository and clone your fork locally

4. Initialize local project (from a CMD, bash, or similar shell within your local download of the project)

   • python3 -m venv .venv

   OR:

   • python -m venv .venv

   This depends on if Python3 is the primary Python version installed on your system.

5. Activate the project

   • Linux/Max/Unix: . .venv/bin/activate

   OR:

   • Windows: .venv\Scripts\activate.bat

6. Install all dependencies

   • pip install -r requirements.txt

Regenerating content locally for testing

1. Activate the project

   • Linux/Max Unix: . .venv/bin/activate

   OR:

   • Windows: .venv\Scripts\activate.bat

2. Reprocess all source documents (content markdown files, etc)

   • pelican

3. Start a local pelican server

   • pelican --listen

4. Navigate to localhost:8000 in your browser :)