export interface UserProfile {
name: string;
github: string;
role: string;
bio: string;
location?: string;
pronouns?: string;
status?: string;
}
export interface SectionBlock {
id: string;
pluginId: string;
visible: boolean;
config: Record<string, any>;
}
export interface ReadmeSettings {
badgeStyle: 'for-the-badge' | 'flat' | 'flat-square';
alignment: 'left' | 'center' | 'right';
theme: string;
camoOptimized: boolean;
}
export interface ReadmeConfig {
version: '2.0.0';
settings: {
user: UserProfile;
badgeStyle: 'for-the-badge' | 'flat' | 'flat-square';
alignment: 'left' | 'center' | 'right';
};
sections: SectionBlock[];
}
{
"version": "2.0.0",
"settings": {
"user": {
"name": "Alex Rivers",
"github": "octocat",
"role": "Full-Stack Systems Engineer",
"bio": "Building resilient open-source developer tooling."
},
"badgeStyle": "for-the-badge",
"alignment": "center"
},
"sections": [
{
"id": "sec-header-1",
"pluginId": "cyber-bot-header",
"visible": true,
"config": {
"status": "ONLINE // ACTIVE",
"quote": "Building systems that scale."
}
},
{
"id": "sec-telemetry-1",
"pluginId": "github-readme-stats",
"visible": true,
"config": {
"theme": "tokyonight",
"showIcons": true
}
}
]
}