Skip to content

14 Blog Page content Updates

Sanjay Viswanathan edited this page Sep 27, 2025 · 12 revisions

Step 1: Always do git pull image

Step 2: Make sure all screenshots are in the range of 1500 x 811 pixels, and name of the image should be proper: for example if it is GitHub installation sample : github Installation setup

Step 3:

When work with blog these few tabs are important

image

image

image

image

image

adding images in blog

image

Hide Table of context & muliple Author

image

---
title: "What are backlinks, How to leverage them for SEO?"
sidebar_label: Microservices
authors: [dharshibalasubramaniyam, ajay-dhangar]
tags: [microservices, springboot, mongodb]
date: 2024-06-17
hide_table_of_contents: true
---

Single Author and table of content

---
title: "Getting Started with React and "
authors: [ajay-dhangar]
tags:
  [
    React,
    JavaScript,
    User interfaces,
    Library,
 
  ]
date: 2024-03-17 12:15:07
description: "Learn how to get started with React by creating a new app using Vite. Follow the steps to set up your development environment and build your first React application."
---

image

Add author in author.yml file.

image

This seperator is important image

📝 GitHub Blog Readability & SEO Review

This document summarizes strengths and areas of improvement in GitHub Blog articles, with actionable takeaways for building developer-friendly, discoverable, and accessible blog content.


✅ What GitHub Blog Does Well

Strong Structure

  • Clear, concise headlines
  • Informative introductions
  • Logical sectioning with relevant headings

Table of Contents

  • Clickable ToC for long posts improves navigation and UX

Practical Step-by-Step Instructions

  • Uses bolding, lists, blockquotes, and Pro tip callouts
  • Clear code formatting for tutorials

Internal Linking

  • Links to related posts, documentation, and product features

Author Attribution & Expertise

  • Author bios with credentials boost credibility

Engagement Options

  • Clear CTAs (“Your next steps”)
  • Social share buttons, newsletter sign-ups, links to docs

Content Diversity

  • Mix of guides, announcements, deep dives, and podcasts

Consistent Voice

  • Approachable, professional, and user-centric tone

⚠️ Areas for Improvement

🔹 Readability

  • Visual Breaks: Paragraphs can be dense → add whitespace, images, bullet lists
  • Alt Text: Missing on some images/GIFs → impacts accessibility
  • Deeper Context: Add case studies or before/after examples
  • Consistent TL;DRs: Some long posts lack a summary

🔹 SEO

  • Meta Descriptions: Ensure unique descriptions ≤ 155 chars
  • Keyword Focus: Use more long-tail keywords for niche dev searches
  • Schema Markup: Add FAQ, HowTo, Product schemas for Rich Snippets
  • Mobile Optimization: Reduce widget density for smaller screens
  • Link Anchor Text: Replace vague text (“read more here”) with descriptive links
  • Page Speed: Optimize image loading, remove unnecessary scripts

🚀 Takeaways for Your Blog

  • ✅ Adopt strong headline structures and logical sectioning
  • ✅ Use bullet lists, code samples, side-by-side visuals for clarity
  • ✅ Add descriptive alt text to every image or GIF
  • ✅ Always include a TL;DR summary for posts > 1000 words
  • ✅ Target long-tail keywords and use descriptive anchor text
  • ✅ Improve accessibility and mobile readability
  • ✅ Double down on internal linking (posts, docs, resources)
  • ✅ Review SEO metadata and Schema markup regularly

📌 Example: GitHub Copilot Blog Review

🔗 GitHub Copilot Coding Agent 101

  • Strengths: Strong structure, practical steps, CTAs, internal linking
  • Improvements: Add TL;DR, descriptive alt text, optimize mobile density, refine keywords

🎯 Final Note

By applying these improvements, your blog will be:

  • Discoverable → SEO-optimized with metadata + schema
  • Scannable → Short paragraphs, bullet points, clear headings
  • Authoritative → Real-world examples, deep dives, and expert attribution
  • Accessible → Alt text, color contrast, mobile-first design

💡 Pro Tip: Regularly audit blog posts for readability, accessibility, and SEO health just like codebases are audited for quality.


📂 Next Steps

  • Add TL;DR summaries to all long posts
  • Audit alt text for all media assets
  • Update meta descriptions + schema for top posts
  • Optimize images and scripts for faster load times
  • Standardize CTAs + anchor link styles

Learn Docs

Clone this wiki locally