🏴‍☠️ Coding Pirates Odense - Knowledge Base

Learning material for Coding Pirates Odense. This repository houses our learning material, presentations, and more.

🌟 What is Quarto?

We use Quarto to build our materials because it allows us to both generate a website and PDFs of our material.

📂 Project Strucutre

This project is organized into the following folders:

• compendiums
• presentations

🛠 Prerequisites

To contribute or run the materials locally, you need:

• Quarto
• Typst CLI
• A text editor (e.g. VSCode)

🚀 How to Use

To preview your changes locally, run the following command:

# Preview the entire library
quarto preview

# Or preview a specific file
quarto preview compendiums/template/index.qmd

Troubleshooting

Sometimes Quarto shows a white page, even though it shouldn't. To fix this, try one of the following:

1. Hard refresh: Ctrl + F5 (Windows/Linux) or Cmd + Shift + R (Mac).
2. Restart: If a refresh dosn't work, stop the command in your terminal (Ctrl + C) and run your preview command again.

Note: Also make sure you are on the correct page.

🤝 Contribute

We want to make it easy to contribute. To encourage fast updates, we allow direct contributions to the main branch without a formal review process.

Guidelines

• New content: Feel free to create and push new compendiums, presentations, and more directly to main. Mark your changes as drafts, if they aren't ready to be on the actual website.
• Existing content: If you wish to modify existing material, please reach out to the original author first to discuss your changes.
• Verify first: Always run a local preview to ensure there are no formatting or code errors before pushing.

Templates

If you want to create a new resource, then you can use the template folder within compendiums or presentations as a starting point. Remember to copy it, not write directly in it.

Workflow

1. Clone the repository

git clone https://github.com/Coding-Pirates-Odense/vidensbank.git

2. Make your changes

3. Preview changes locally

quarto preview

4. Push to main

Commit your changes to the main branch.

5. Publishing

To make your changes live on the website, run the following command from the main branch:

quarto publish gh-pages

This command will render the website, copy the output to the gh-pages branch, and push the changes to GitHub. GitHub will then add the changes to our website.