Profile README

Profile README in SnippKit allows you to render a personalized, GitHub-style Markdown document directly at the top of your public developer profile (/u/<username>).

Use your profile README to introduce yourself to the community, showcase your primary tech stack, feature top projects, or link to social channels and personal websites.

Overview

Just like GitHub profile READMEs, SnippKit gives you a dedicated Markdown editor (/u/<username>/readme) to customize your profile front-page.

When enabled, your README appears inside a styled card directly below your main profile header, visible to visiting developers and team members.

Direct App Shortcut

Edit your profile README directly: .

What you can do

With Profile README, you can:

Write Rich Markdown: Author Markdown with syntax-highlighted code blocks, badges, links, and lists.
Write / Preview Tabs: Toggle between the code editor and live Markdown preview in real time.
Unsaved Changes Protection: Work safely with built-in browser exit guards that prevent accidental data loss.
Visibility Toggle: Enable or disable your profile README at any time from Profile Settings.

Getting started

Quick Links

— Open your live Markdown editor.
Profile Settings (/settings/profile) — Enable or disable your README card visibility.

Editing your profile README

Navigate to your profile or click .
Use the Write tab to author your Markdown content.
Click the Preview tab to check how your rendered README will appear to visitors.
Click Save Changes in the top header.

Supported Markdown Syntax

SnippKit uses standard GFM rendering with support for:

1. Code Blocks & Syntax Highlighting

BASH

function greet(developer) { console.log(`Hello, ${developer}! Welcome to SnippKit.`); }

2. GitHub Alerts

[!NOTE] Currently exploring WebAssembly and Rust for high-performance microservices.

[!TIP] Check out my pinned snippets below for quick DevOps utility scripts!

3. Formatting & Links

Lists: Bullet points and numbered sequences.
Badges: Standard Shields.io SVG badges (e.g., ![React](https://img.shields.io/badge/React-20232A?logo=react)).
Links: Clickable URLs to external portfolios, repositories, or social profiles.

Unsaved Changes Guard

To prevent accidental loss of uncommitted edits:

Browser Guard: Attempting to refresh or close the tab with unsaved changes triggers a browser confirmation alert.
Navigation Modal: Navigating away via internal links opens an exit confirmation modal prompting you to save or discard changes.

Enabling & Disabling Profile README

You can hide or reveal your profile README at any time:

Open Profile Settings (/settings/profile).
Locate the Enable Profile README toggle.
Toggle to Enabled or Disabled.
Click Save Changes.

Disabling your README hides the card from visitors without deleting your written Markdown content.

Profile Customization — Edit your display name, bio, avatar, and social links.
Find Developers — Discover public developer profiles across SnippKit.
Create Snippets — Create reusable code snippets to display on your profile.