Ensures Heading H1 for all documents

Author: pastuxso

EASTER.md

@@ -1,7 +1,13 @@
+---
+runme:
+  id: 01HX525D97B8P5F5BY0NQFMHEK
+  version: v3
+---
+
 ### Hit the SPACE bar in Chrome to launch this easter egg 🐰
 
 [![](https://badgen.net/badge/Run%20this%20/EASTER.md/5B3ADF?icon=https://runme.dev/img/logo.svg)](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fstateful%2Frunme.dev.git&fileToOpen=EASTER.md)
 
-```sh { interactive=false mimeType=image/gif }
+```sh {"interactive":"false","mimeType":"image/gif"}
 curl https://runme.dev/img/dinosaur.gif 2>/dev/null
 ```

PLAN.md

@@ -1,3 +1,9 @@
+---
+runme:
+  id: 01HX525D98X6QC2RFEGWS5452E
+  version: v3
+---
+
 # Docs Improvements Plan
 
 Notes and description of gaps in documentation.

docs/Reference/configuration.md

@@ -1,11 +1,13 @@
 ---
 runme:
   id: 01HG11HG1XY3V7DCQVQ32Q71ZZ
-  version: v2.0
+  version: v3
 sidebar_position: 1
 title: Options for Document and Cell
 ---
 
+# Options for Document and Cell
+
 Executing code and commands in Runme can be done either at the [Document level](../configuration/document-level) or the [Cell level](../configuration/cell-level). This page is a reference for both features.
 
 ### **Document Options**
@@ -42,5 +44,3 @@ Metadata inside Markdown's fenced code blocks.
 This feature can be used to prevent [prompting](../configuration/document-level) when exporting an environment variable. By configuring the [cell options](../configuration/cell-level) appropriately, you can streamline your workflow and make your environment setup more efficient.
 
 </Infobox>
-
-

docs/Reference/flag.md

@@ -1,9 +1,12 @@
 ---
+runme:
+  id: 01HX525D99NZJ6YPEFFBVMRTC6
+  version: v3
 sidebar_position: 2
 title: Commands and Flags
 ---
 
-
+# Commands and Flags
 
 Runme executes commands inside your runbooks, documentation, and READMEs. It parses commands directly from Markdown files to make them executable.
 
@@ -37,7 +40,6 @@ Below are some available commands within Runme
 
 Runme supported configuration flags.
 
-
 | Flags         | Description                                                     |
 | ---------------------- | --------------------------------------------------------------- |
 | --allow-unknown           | Display snippets without known executor (default true)  |
@@ -58,4 +60,3 @@ Runme supported configuration flags.
 | -s, --server string          | Server address to connect runner to |
 | --tls string | Directory for TLS authentication (default "~/Library/Application Support/runme/tls")                  |
 | -v, --version          |  -v, --version |
-

docs/Reference/index.md

@@ -1,8 +1,12 @@
 ---
+runme:
+  id: 01HX525D99NZJ6YPEFFE36FGGG
+  version: v3
 sidebar_position: 7
 title: Reference
 ---
 
+# Reference
 
 In this reference section, we will cover a range of terms, commands, and flags used on Runme and a brief description of these terminologies to enable you to understand each term and how they are used.
 

docs/Reference/mime.md

@@ -1,8 +1,12 @@
 ---
+runme:
+  id: 01HX525D99NZJ6YPEFFHHEHXTK
+  version: v3
 sidebar_position: 4
 title: Supported MIME types
 ---
 
+# Supported MIME types
 
 Runme supports the standard VS Code MIME types alongside custom Runme MIME types.
 

docs/architecture.md

@@ -1,8 +1,13 @@
 ---
+runme:
+  id: 01HX525D99NZJ6YPEFFMPYFVR4
+  version: v3
 sidebar_position: 7
 title: Kernel Architecture
 ---
 
+# Kernel Architecture
+
 Under the hood, much like other Notebook technologies such as Jupyter, Runme breaks down into the following parts:
 
 - A serializer that transforms Markdown into executable cells with input and output

docs/configuration/archiving.md

@@ -1,11 +1,13 @@
 ---
 runme:
   id: 01HGAP763P40ATQQN75RMGW6XJ
-  version: v2.0
+  version: v3
 sidebar_position: 4
 title: Archiving Feature
 ---
 
+# Archiving Feature
+
 The Runme archiving feature is a tidy-up tool for users. It allows you to hide outputs generated from Markdown cells to reduce clutter and preserve output for future reference. The archived files are securely stored in [Runme cloud](https://app.runme.dev/welcome) which can be accessible at any time.
 
 On the Runme cloud, your data is encrypted both at rest and in transit, ensuring end-to-end security

docs/configuration/auto-save.md

@@ -1,11 +1,13 @@
 ---
 runme:
   id: 01HFRZ3233HSQ0NVJB9BE682G5
-  version: v2.0
+  version: v3
 sidebar_position: 5
 title: Auto-Save Feature
 ---
 
+# Auto-Save Feature
+
 Runme auto-save feature makes saving your outputs and progress easier. It is an effective way to manage your records and outputs throughout your deployment.
 
 The Runme autosave feature automatically records and tracks every change and activity in your deployment process without manual intervention, so you can focus on your task and team collaboration without worrying about losing your outputs.
@@ -76,6 +78,3 @@ By default, session output is turned off, indicated by the autosave button at th
 This action configures the system to automatically save the output of each cell execution.
 
 > 💡 If you’re logged into the Cloud (prompt whenever Auto-Save is toggled on) cells will both be stored locally in a Session Outputs file and securely stored in your dashboard for later review or sharing with others. This is completely optional and if desired can be turned off (follow “Open Settings” in prompt).
-
-
-

docs/configuration/cell-level.md

@@ -1,11 +1,13 @@
 ---
 runme:
   id: 01HFPW3ES358GNC1Z633JB8JYR
-  version: v2.0
+  version: v3
 sidebar_position: 1
 title: Cell-level Options
 ---
 
+# Cell-level Options
+
 When running code blocks or commands with Runme, you have two execution options: document-level or cell-level options.
 
 The cell-level options allow you to run your Markdown file by cell rather than execute the entire file at once.
@@ -87,7 +89,7 @@ Take a look at more [examples](https://github.com/stateful/vscode-runme/tree/mai
 
 </Infobox>
 
-###  **Specify Language in Blocks**
+### **Specify Language in Blocks**
 
 Runme, just like most Markdown viewers, will work best when a script's language is contained inside fenced code blocks.
 
@@ -117,7 +119,7 @@ While this works well in a lot of cases, the accuracy is not perfect.
 
 </Infobox>
 
-###  **Handle long-running processes**
+### **Handle long-running processes**
 
 It is common to use file-watcher-enabled compilers/bundlers (e.g., `npm start dev`, `watchexec`, etc.) in the background during development.
 For any cell containing an instance of these commands, tick the background cell setting. This will prevent execution from permanently blocking the notebook UX.
@@ -164,7 +166,7 @@ Please note that if both `cwd` is set for doc-level and cell, they don't overw
 
 </Infobox>
 
-###  **Interactive vs non-interactive cells**
+### **Interactive vs non-interactive cells**
 
 If a cell's commands do not require any input from a reader it might be a good fit to include the cell's output inside the notebook. This is useful if the resulting output could be useful as input in a downstream cell. This is what `interactive=false` is for, and it defaults to *true*.
 
@@ -184,7 +186,7 @@ Please note that the Runme team is currently working on making output in both no
 
 </Infobox>
 
-###  **Set environment variables**
+### **Set environment variables**
 
 If a cell has exported variables, the user will be prompted to set these variables. This can be useful to have a parameterized cell while not needing to manually modify the cell.
 
@@ -200,7 +202,6 @@ sleep $SLEEP_SECS
 There are two prompt modes:
 
 - Use a placeholder
-
 - A prompt message.
 
 Here's the difference:
@@ -223,7 +224,7 @@ export PROJECT_ID=Enter a valid project ID
 cli make-call --project-id $PROJECT_ID describe
 ```
 
-###  **Terminal visibility post-execution**
+### **Terminal visibility post-execution**
 
 A cell's execution terminal is auto-hidden unless it fails. This default behavior can be overwritten if keeping the terminal open is in the interest of the Runme notebook reader. Just untick `closeTerminalOnSuccess` (`false`).
 
@@ -236,7 +237,7 @@ A cell's execution terminal is auto-hidden unless it fails. This default behavio
 docker ps | grep runme/demo:latest
 ```
 
-###  **Human-friendly output**
+### **Human-friendly output**
 
 Not all cells’ output is plain text. For example, you can have JSON, text, images, etc, all in your Markdown file.
 
@@ -246,7 +247,7 @@ Using the `mimeType` specifier, you can specify the expected output type. Runm
 
 See in the [reference page](../Reference/mime) for the list of supported MIME types!
 
-###  **Terminal Row**
+### **Terminal Row**
 
 On Runme outputs are saved in lines also known as rows. The number of lines or rows in which an output should be rendered is defined by a setting known as Terminal row.
 Terminal row allows you to set the number of rows with which your output should be displayed under a cell.
@@ -270,7 +271,7 @@ We have provided a list of configuration settings to upgrade your experience usi
 
 - Lastly, set the number of rows you wish your output to be rendered in.
 
-###  **Unnamed vs Named cells**
+### **Unnamed vs Named cells**
 
 On Runme cells are unnamed by default. However, you can name a cell directly in your notebook. This will enable you to easily identify the cell using the provided cell name. On the cell you wish to name, simply click on the “Add Name” button on the cell.
 
@@ -315,7 +316,7 @@ Take a look at more [examples](https://github.com/stateful/vscode-runme/tree/mai
 
 </Infobox>
 
-###  **Exclude Cell from Run All**
+### **Exclude Cell from Run All**
 
 Every VS Code notebook allows users to run all available cells. This can be useful if you define a complete runbook in your Markdown file, allowing developers to click the **Run All** button to get set up and running.
 
@@ -330,8 +331,7 @@ However, sometimes certain cells should be excluded from this workflow. You can
  # Do something optional here
 ```
 
-
-###  **Run All Cells by Category**
+### **Run All Cells by Category**
 
 If you have multiple workflows in a single Markdown file you can categorize them and allow your developers to run all cells by a certain category. To enable that you can add a category as a cell option. A cell can have one or multiple categories that are comma-separated.
 
@@ -348,5 +348,3 @@ If you have multiple workflows in a single Markdown file you can categorize them
   <source src="/videos/categories.mp4" type="video/mp4" />
   <source src="/videos/categories.webm" type="video/webm" />
 </video>
-
-