Discover gists

Writing markdown files for AI assistants

Builds on concepts from Introduction to Markdown.

Markdown files serve a dual purpose when working with AI coding assistants: they're human-readable documentation AND machine-parseable instructions. This tutorial explores the design considerations most users overlook.

The invisible audience problem

When you write a README.md, you think about human readers. When you write a .github/copilot-instructions.md, you're writing for an AI that will interpret your instructions. But here's what many users miss: the AI reads your markdown differently than humans do.

	// Before: A typical "just make it work" modifier chain
	// Before: "works", but heavier than it looks
	Modifier
	.clickable { onMessageClick() } // hit-test too early
	.padding(horizontal = 12.dp, vertical = 6.dp)
	.background(
	color = MaterialTheme.colorScheme.surfaceVariant,
	shape = RoundedCornerShape(12.dp)
	)
	.fillMaxWidth()

	Log uploaded on Sunday, January 25, 2026, 4:27:38 PM
	Loaded mods:
	Harmony(brrainz.harmony)[mv:2.4.2.0]: 0Harmony(2.4.1), HarmonyMod(2.4.2)
	Core(Ludeon.RimWorld): (no assemblies)
	Royalty(Ludeon.RimWorld.Royalty): (no assemblies)
	Ideology(Ludeon.RimWorld.Ideology): (no assemblies)
	Biotech(Ludeon.RimWorld.Biotech): (no assemblies)
	Anomaly(Ludeon.RimWorld.Anomaly): (no assemblies)
	Odyssey(Ludeon.RimWorld.Odyssey): (no assemblies)
	HugsLib(UnlimitedHugs.HugsLib)[ov:12.0.0]: 0Harmony(av:2.4.1,fv:1.2.0.1), HugsLib(av:1.0.0,fv:12.0.0)

	/***
	[task_local]
	event-interaction https://gist.githubusercontent.com/love4taylor/28c15e87354225182b36d178be29f2ca/raw/server-info-plus.js, tag=节点信息Plus, img-url=info.bubble.system.system
	@XIAO_KOP
	2023-04-14
	**/

	// var content= `<p style="text-align: center; font-family: -apple-system; font-size: large; font-weight: bold">` + response.body + `</p>`;

	let base_url = "https://scamalytics.com/ip/"

	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<title>SmartBook AI - Easy Financial Reporting (MASB Style)</title>
	<script src="https://cdn.tailwindcss.com"></script>
	<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700;800&display=swap" rel="stylesheet">

	<!-- PDF Generation Libraries -->

	import os
	import sys
	import socket
	from pathlib import Path
	from datetime import datetime, timedelta, timezone, date
	from zoneinfo import ZoneInfo
	import threading
	from concurrent.futures import ThreadPoolExecutor
	import queue
	from typing import Any, Dict, NoReturn

	{
	"date": "2026-01-25T13:27:09.154Z",
	"runs": 5,
	"results": [
	{
	"dataset": "test/small-files",
	"perWorker": 1,
	"batchSize": 8,
	"chunk": 131072,
	"stats": {



	RT @MastChain_DePIN: One more on board!
	Which means .. 🎉 We just hit 500 users on MastChain

	All aboard the #DePIN #MastChain Ship!

	We h…

	— @alexdolbun (@alexdolbun)

	#!/bin/bash

	# 设备 A 的 Tailscale IP
	REMOTE_IP="100.100.120.233"

	echo "------------------------------------------"
	echo "🔍 正在通过 ifconfig 检测本地 IP..."
	echo "------------------------------------------"

	# 直接使用 ifconfig 过滤显示非本地和非 Tailscale 的 IP