0x5eal/luau-unzip
1
1
Fork 0
mirror of https://github.com/0x5eal/luau-unzip.git synced 2025-04-10 17:20:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore(lune): use proper markdown heading hierarchy in docsgen

Browse source
This commit is contained in:
Erica Marigold 2025-02-23 12:08:57 +00:00
parent fea6567014
commit 638c017f0a
Signed by: DevComp
SSH key fingerprint: SHA256:jD3oMT4WL3WHPJQbrjC3l5feNCnkv7ndW8nYaHX5wFw
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.lune/docsgen/markdown.luau
View file

@ -4,7 +4,7 @@ local moonwave = require("./moonwave")
local logger = require("./log") local logger = require("./log")
local function writeSectionHeader(buf: string, title: string) local function writeSectionHeader(buf: string, title: string)
buf ..= `## {title}\n` buf ..= `### {title}\n`
return buf return buf
end end
@ -14,7 +14,7 @@ local function writeRef(buf: string, name: string, fragment: string?)
end end
local function writeClass(buf: string, name: string, desc: string) local function writeClass(buf: string, name: string, desc: string)
buf ..= `# \`{name}\`\n` buf ..= `## \`{name}\`\n`
buf ..= desc buf ..= desc
buf ..= `\n\n` buf ..= `\n\n`
return buf return buf
@ -49,7 +49,7 @@ local function writeFunction(
) )
local sep = if type == "method" then ":" else "." local sep = if type == "method" then ":" else "."
local declaredSignature = `{class}{sep}{name}` local declaredSignature = `{class}{sep}{name}`
buf ..= `### \`{name}\`\n` buf ..= `#### \`{name}\`\n`
if private then if private then
buf ..= `> [!IMPORTANT]\n` buf ..= `> [!IMPORTANT]\n`
@ -148,7 +148,7 @@ local function writeMarkdown(path: string, items: { moonwave.Item })
continue continue
end end
buf ..= `### \`{type.name}\`\n` buf ..= `#### \`{type.name}\`\n`
if type.private then if type.private then
buf ..= `> [!IMPORTANT]\n` buf ..= `> [!IMPORTANT]\n`
buf ..= `> This is a private type. It may be exported publicly, but try to avoid\n` buf ..= `> This is a private type. It may be exported publicly, but try to avoid\n`