puppetto logo puppetto

Blog Yo Self: Contributing to Puppetto Blog

By puppetto
guideblogcontributing

Learn how to contribute content to the Puppetto blog using our MDX components

Contributing to the Puppetto Blog

💡

Want to share your Puppetto journey? This guide will show you how to create engaging blog posts using our custom MDX components.

Getting Started

First, let's understand the structure of a blog post. Every post starts with a frontmatter header:

---
title: 'My Awesome Puppetto Post'
description: 'A short summary of my post'
date: '2024-08-08'
image: '/assets/blog/my-image.png'
author: 'yourname'
authorImage: '/assets/characters/your-avatar.png'
tags: ['guide', 'puppetto']
envs: ['development', 'production']
---

The frontmatter provides metadata for your post. Make sure to update the fields to match your content.


Writing Your Content

After the frontmatter, you can use Markdown as usual. But with Puppetto, you also have access to custom MDX components to make your post more interactive and visually appealing.

Supported Components

Here are some of the custom components you can use:

  • <Callout type="info" | "warning" | "tip" | "success" | "danger">
    Highlight important information, warnings, or tips.

  • <Checklist items={[{ text: 'Do this', checked: false }]} />
    Show a checklist for steps or requirements.

  • <Step number={1} title="Step Title"> ... </Step>
    Break down your guide into clear steps.

  • <HighlightBox title="Box Title"> ... </HighlightBox>
    Draw attention to key concepts or outcomes.

  • <CodeBlock language="js"> ... </CodeBlock>
    Display code snippets with syntax highlighting.

  • <Image src="/path/to/image.png" alt="Description" />
    Add images to your post.

Example: Using Components

Here's a sample section using some of these components:

1

Fork the Repository

Go to the Puppetto GitHub repo
Click "Fork" to create your own copy
2

Create Your Post

Create a new `.mdx` file in `src/app/blog/posts/markdown/`
Add your frontmatter and content
Use MDX components to enhance your post
💡

Use <CodeBlock> to show code, and <Checklist> to guide readers through steps!

Submitting Your Post

Once your post is ready:

Check your frontmatter for accuracy
Preview your post locally
Open a Pull Request on GitHub
Wait for review and feedback

Need Help?

If you have questions or need help with MDX components, reach out in the Puppetto Discord or open an issue on GitHub!

Style Guide

  • Be clear and concise.
  • Use headings (##) to organize sections.
  • Add images or code where helpful.
  • Tag your post appropriately in the frontmatter.
  • Keep it friendly and fun!

Inspiration

Not sure what to write? Here are some ideas:

  • How you use Puppetto in your projects
  • Tips for creating engaging videos
  • Behind-the-scenes of your favorite set designs
  • Tutorials for new users

Ready to Blog?

We can't wait to see what you create!
Happy blogging, and welcome to the Puppetto community.

🚀 Your story could inspire the next generation of AI creators!