Quick Start Guide
Adding Your First Notebook Entry
Copy the template:
cp posts/_template.qmd posts/2024-01-16-my-first-entry.qmd
Edit the file and update the YAML frontmatter:
--- title: "My First Lab Entry" author: "Ariana Huffmyer" date: "2024-01-16" categories: [project-coral, methods, fieldwork] description: "Description of today's work" draft: false ---
Write your content using Markdown
Preview locally (optional):
quarto preview
Commit and push to GitHub:
git add posts/2024-01-16-my-first-entry.qmd git commit -m "Add lab entry for 2024-01-16" git push
The site will automatically rebuild and deploy!
Customizing Your Pages
Update Your CV/About Page
Edit about.qmd
to add your: - Education history - Publications - Professional experience - Contact information
Add Research Projects
Edit research.qmd
to describe your research projects, methods, and findings.
Build an Image Gallery
Create an
images/
folderAdd your photos
Edit
gallery.qmd
to reference them:
Organizing Notebook Entries
Use Meaningful Categories
Good category examples: - Project names: coral-bleaching
, RNA-seq-analysis
- Methods: fieldwork
, lab-work
, data-analysis
- Topics: molecular-biology
, statistics
, microscopy
Consistent Naming
Use a consistent file naming pattern: - YYYY-MM-DD-descriptive-name.qmd
- Example: 2024-01-16-coral-sampling-reef-site-a.qmd
GitHub Pages Setup
After you push your code to GitHub:
- Go to repository Settings → Pages
- Under “Source”, select GitHub Actions
- Wait for the workflow to complete (check the Actions tab)
- Your site will be live at:
https://ahuffmyer.github.io/website/
Tips
- Preview locally before pushing to see how your changes look
- Use categories consistently for better searchability
- Add images to make your notebook more visual
- Write regularly - the notebook is most useful when updated frequently
- Back up important data - commit raw data files to a separate repository
Getting Help
- Quarto Documentation: https://quarto.org/docs/guide/
- Markdown Guide: https://www.markdownguide.org/
- Quarto Community: https://github.com/quarto-dev/quarto-cli/discussions
Next Steps
- Customize all pages with your information
- Create your first real notebook entry
- Add images to the gallery
- Set up GitHub Pages
- Share your website URL!