post

Markdown Post Guide

Markdown Post Guide

Overview

This guide explains how to create a Markdown-formatted blog post using the Snowlake Jekyll theme, leveraging Kramdown’s extended Markdown capabilities.

Front Matter Configuration

Layout and Basic Information

layout: posts/post                # Required layout for Markdown post
title: "Post Title"               # Main title of the blog post
date: YYYY-MM-DD HH:MM:SS +TIMEZONE  # Publication date and time

Categorization and Metadata

categories: [category1, category2]  # Post categories
tags: [tag1, tag2]                  # Post tags
author: "Author Name"               # Post author
post_image: "/path/to/image.webp"   # Featured post image

Advanced Metadata

badge_color: "bg-violet"            # Optional badge color
meta_title: "SEO Title"             # SEO-optimized title
meta_description: |                 # SEO description
  Detailed description of the post
permalink: "/posts/post-slug"       # Custom permalink

Markdown Formatting Guide

Headings

# H1 Heading
## H2 Heading
### H3 Heading
#### H4 Heading
##### H5 Heading
###### H6 Heading

Alternative H1 Heading
=====================

Alternative H2 Heading
----------------------

Text Formatting

*Italic text*
**Bold text**
***Bold and Italic text***
~~Strikethrough text~~
`Inline code`

Lists

Unordered Lists:
- Item 1
- Item 2
  - Nested Item 2.1
  - Nested Item 2.2

Ordered Lists:
1. First item
2. Second item
3. Third item

[Link Text](https://example.com)
[Link with Title](https://example.com "Link Title")

Blockquotes

> This is a blockquote
> 
> Can span multiple lines
>
> #### Blockquote with Heading
> Nested content is possible

Code Blocks

Inline code: `code`

Fenced Code Block:
```python
def hello_world():
    print("Hello, World!")

Indented Code Block: def hello_world(): print(“Hello, World!”)


### Images
```markdown
![Alt Text](/path/to/image.webp)
![Image with Title](/path/to/image.webp "Image Title")

Best Practices

Content Writing

  1. Use semantic headings
  2. Break content into digestible sections
  3. Utilize Markdown formatting effectively
  4. Include relevant links and images
  5. Maintain a consistent writing style

Markdown Optimization

  • Use meaningful link texts
  • Provide descriptive alt text for images
  • Keep code blocks concise
  • Use appropriate heading levels
  • Leverage Kramdown extensions

Customization Options

  • Modify post layout
  • Add custom CSS classes
  • Implement advanced Markdown features
  • Control permalink structure
  • Customize metadata

SEO Optimization

  • Write descriptive meta titles
  • Create comprehensive meta descriptions
  • Use relevant categories and tags
  • Optimize image alt texts
  • Implement internal linking

Accessibility Considerations

  • Use semantic HTML
  • Provide descriptive link texts
  • Ensure color contrast
  • Support screen readers
  • Use proper heading hierarchy

Troubleshooting

  • Verify Markdown syntax
  • Check image and link paths
  • Test permalink functionality
  • Validate front matter
  • Ensure proper indentation

Example Workflow

  1. Choose a compelling topic
  2. Outline content structure
  3. Write using Markdown
  4. Apply formatting
  5. Add images and links
  6. Configure front matter
  7. Review and refine
  8. Publish