Skip to content

docs: add llms.txt outputs to docs build #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bradygaster merged 1 commit into from
Feb 17, 2026
Merged

docs: add llms.txt outputs to docs build #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 124 additions & 1 deletion docs/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ function fileSorter(a, b) {
return nameA.localeCompare(nameB);
}

function stripFrontmatter(raw) {
return raw.replace(/^---\s*\n[\s\S]*?---\s*\n/, '');
}

function toMarkdownCompanionPath(rel) {
return toHtmlPath(rel) + '.md';
}

function escapeHtml(s) {
return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
}
Expand Down Expand Up @@ -145,6 +153,117 @@ function copyDir(src, dest) {
}
}

function extractFirstLine(abs) {
var raw = fs.readFileSync(abs, 'utf8');
var body = stripFrontmatter(raw);
var lines = body.split('\n');
for (var i = 0; i < lines.length; i++) {
var line = lines[i].trim();
if (!line) continue;
if (line.startsWith('#') || line.startsWith('---') || line.startsWith('!') || line.startsWith('[')) continue;
if (line.startsWith('|') || line.startsWith('```')) continue;

line = line
.replace(/^>\s*/, '')
.replace(/^[-*+]\s+/, '')
.replace(/^\d+\.\s+/, '')
.replace(/!\[([^\]]*)\]\([^)]+\)/g, '$1')
.replace(/\[([^\]]+)\]\([^)]+\)/g, '$1')
.replace(/[*_`~]/g, '')
.replace(/\s+/g, ' ')
.trim();

if (line) {
if (line.length > 200) return line.substring(0, 197).trimEnd() + '...';
return line;
}
}
return '';
}

function generateLlmsTxt(files) {
var lines = [];
lines.push('# Squad');
lines.push('');
lines.push('> AI agent teams for any project. A team that grows with your code.');
lines.push('');
lines.push('Squad gives you an AI development team through GitHub Copilot. Describe what you\'re building. Get a team of specialists that live in your repo as files, persist across sessions, learn your codebase, and share decisions.');
lines.push('');

var sections = { guides: [], features: [], scenarios: [], blog: [] };
for (var i = 0; i < files.length; i++) {
var f = files[i];
var rel = f.rel.replace(/\\/g, '/');
if (rel.startsWith('features/')) sections.features.push(f);
else if (rel.startsWith('scenarios/')) sections.scenarios.push(f);
else if (rel.startsWith('blog/')) sections.blog.push(f);
else sections.guides.push(f);
}

var sectionDefs = [
{ key: 'guides', label: 'Guides' },
{ key: 'features', label: 'Features' },
{ key: 'scenarios', label: 'Scenarios' },
{ key: 'blog', label: 'Optional' }
];

for (var s = 0; s < sectionDefs.length; s++) {
var sec = sectionDefs[s];
var items = sections[sec.key];
if (!items.length) continue;
items.sort(fileSorter);
lines.push('## ' + sec.label);
lines.push('');
for (var j = 0; j < items.length; j++) {
var item = items[j];
var title = extractTitle(item.abs) || nameFromFile(item.rel);
var mdPath = toMarkdownCompanionPath(item.rel);
var url = BASE_PATH + '/' + mdPath;
var desc = extractFirstLine(item.abs);
var entry = '- [' + title + '](' + url + ')';
if (desc) entry += ': ' + desc;
lines.push(entry);
}
lines.push('');
}

return lines.join('\n');
}

function generateLlmsFullTxt(files) {
var parts = [];
parts.push('# Squad — Complete Documentation');
parts.push('');

var included = files.slice();
included.sort(fileSorter);

for (var i = 0; i < included.length; i++) {
var f = included[i];
var raw = fs.readFileSync(f.abs, 'utf8');
var body = stripFrontmatter(raw).trim();
parts.push('---');
parts.push('');
parts.push('Source: ' + f.rel.replace(/\\/g, '/'));
parts.push('');
parts.push(body);
parts.push('');
}

return parts.join('\n');
}

function copyMarkdownFiles(files) {
for (var i = 0; i < files.length; i++) {
var f = files[i];
var raw = fs.readFileSync(f.abs, 'utf8');
var body = stripFrontmatter(raw);
var companionPath = path.join(OUT_DIR, toMarkdownCompanionPath(f.rel));
fs.mkdirSync(path.dirname(companionPath), { recursive: true });
fs.writeFileSync(companionPath, body);
}
}

function build() {
var files = walk(DOCS_DIR);
console.log('Found ' + files.length + ' markdown files');
Expand All @@ -157,7 +276,7 @@ function build() {
for (var i = 0; i < files.length; i++) {
var f = files[i];
var raw = fs.readFileSync(f.abs, 'utf8');
var stripped = raw.replace(/^---\s*\n[\s\S]*?---\s*\n/, '');
var stripped = stripFrontmatter(raw);
var rendered = md.render(stripped);
var rewritten = rewriteLinks(rendered);
var title = extractTitle(f.abs) || nameFromFile(f.rel);
Expand All @@ -167,6 +286,10 @@ function build() {
fs.mkdirSync(path.dirname(outPath), { recursive: true });
fs.writeFileSync(outPath, html);
}
fs.writeFileSync(path.join(OUT_DIR, 'llms.txt'), generateLlmsTxt(files));
fs.writeFileSync(path.join(OUT_DIR, 'llms-full.txt'), generateLlmsFullTxt(files));
copyMarkdownFiles(files);
console.log('Generated llms.txt, llms-full.txt, and markdown companions');
var assetsDir = path.join(DOCS_DIR, 'assets');
if (fs.existsSync(assetsDir)) copyDir(assetsDir, path.join(OUT_DIR, 'assets'));
console.log('Built ' + files.length + ' pages to ' + OUT_DIR);
Expand Down
Loading