Markdown improvement (#547)

microsoft · Jun 15, 2024 · 7ba0043 · 7ba0043
1 parent 3a70f7a
commit 7ba0043
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/src/content/docs/getting-started/your-first-genai-script.mdx b/docs/src/content/docs/getting-started/your-first-genai-script.mdx
@@ -95,13 +95,13 @@ GenAIScript exposes the context through the `env` variable. The context is impli
 -   you can right click on or in a file and the `env.files` will contain only that file.
 -   you can run the script using the [command line interface](/genaiscript/reference/cli) and specify content of `env.files` in the CLI arguments.
 
-```js title="proofreader.genai.js" system=false assistant=false
+```js title="proofreader.genai.js" system=false assistant=false user=true
 def("FILES", env.files)
 ```
 
 {/* genaiscript output start */}
 
-<details>
+<details open>
 <summary>👤 user</summary>
 
 

diff --git a/packages/core/src/github.ts b/packages/core/src/github.ts
@@ -73,6 +73,7 @@ export async function githubUpdatePullRequestDescription(
     const token = await host.readSecret(GITHUB_TOKEN)
     if (!token) return { updated: false, statusText: "missing github token" }
 
+    text = prettifyMarkdown(text)
     text += generatedByFooter(script, info)
 
     const fetch = await createFetch({ retryOn: [] })

diff --git a/packages/core/src/markdown.ts b/packages/core/src/markdown.ts
@@ -4,9 +4,14 @@ import { trimNewlines } from "./util"
 export function prettifyMarkdown(md: string) {
     let res = md
     res = convertAnnotationsToMarkdown(res)
+    res = cleanMarkdown(res)
     return res
 }
 
+export function cleanMarkdown(res: string): string {
+    return res?.replace(/(\r?\n){3,}/g, "\n\n")
+}
+
 export function fenceMD(t: string, contentType?: string) {
     if (t === undefined) return undefined
     if (!contentType) contentType = "markdown"