Contributing to GDG Learning Platform Articles
Welcome to the GDG Learning Platform Articles project. This guide helps you contribute technical articles to our community.
Getting Started
Clone and Setup
git clone https://github.com/GDGAlgiers/glp-articles.git
cd glp-articles
npm install
npm run dev
Write Your Article
Create a new .md file in src/articles/ with this frontmatter:
---
title: "Your Article Title"
description: "Brief description of your article"
author: "Your Name"
date: "2025-01-15"
tags: ["javascript", "react", "tutorial"]
---
# Your Article Title
Your content here...
Article Guidelines
- Use clear, descriptive titles
- Include practical code examples
- Add proper tags for categorization
- Keep content focused and well-structured
- Test all code examples before submitting
Submission Process
- Create a new branch:
git checkout -b article/your-topic - Add your article to
src/articles/ - Test locally:
npm run dev - Commit changes:
git commit -m "Add article: Your Title" - Push branch:
git push origin article/your-topic - Create a Pull Request
Content Standards
- Write for developers of all skill levels
- Use proper markdown formatting
- Include code syntax highlighting
- Add relevant external links
- Keep articles between 500-2000 words
Technical Notes
This platform uses:
- Next.js 15 with App Router
- Markdown files (not MDX) for simplicity
- markdown-it for rendering
- highlight.js for syntax highlighting
- Tailwind CSS for styling
Need Help?
- Check existing articles for examples
- Join our GDG Algiers Discord
- Open an issue for questions
Happy writing!