prevent mdformat from breaking yaml frontmatter

PiperOrigin-RevId: 542002599
google · Jun 20, 2023 · 344d787 · 344d787
1 parent 2a8302b
commit 344d787
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 27 deletions.
diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md
@@ -1,12 +1,21 @@
---------------------------------------------------------------------------------
-
-title: "HEIR: Homomorphic Encryption Intermediate Representation" linkTitle:
-Home menu: {main: {weight: 1}} weight: 1
-
-cascade: - type: "blog" # uncomment this to make blog disappear from the
-sidebar # toc_root: true _target: path: "/blog/**" - type: "docs" _target:
-
-## path: "/**"
+<!-- mdformat off(yaml frontmatter) -->
+---
+title: "HEIR: Homomorphic Encryption Intermediate Representation"
+linkTitle: Home
+menu: {main: {weight: 1}}
+weight: 1
+
+cascade:
+  - type: "blog"
+    # uncomment this to make blog disappear from the sidebar
+    # toc_root: true
+    _target:
+      path: "/blog/**"
+  - type: "docs"
+    _target:
+      path: "/**"
+---
+<!-- mdformat on -->
 
 ## What is HEIR?
 

diff --git a/docs/content/en/blog/_index.md b/docs/content/en/blog/_index.md
@@ -1,6 +1,8 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Blog
 weight: 100
 linkTitle: Blog
 menu: {main: {weight: 30}}
 ---
+<!-- mdformat on -->
diff --git a/docs/content/en/blog/hello_world.md b/docs/content/en/blog/hello_world.md
@@ -1,9 +1,12 @@
---------------------------------------------------------------------------------
-
-title: "Hello, World!" date: 2023-06-13T13:15:10-07:00 linkTitle: "Hello,
-World!" description: > We're starting a compiler toolchain for homomorphic
-encryption compilers.
-
-## author: Jeremy Kun ([@j2kun](https://jeremykun.com))
+<!-- mdformat off(yaml frontmatter) -->
+---
+title: "Hello, World!"
+date: 2023-06-13T13:15:10-07:00
+linkTitle: "Hello, World!"
+description: >
+  We're starting a compiler toolchain for homomorphic encryption compilers.
+author: [Jeremy Kun](https://jeremykun.com)
+---
+<!-- mdformat on -->
 
 Announcement!
diff --git a/docs/content/en/community/_index.md b/docs/content/en/community/_index.md
@@ -1,20 +1,21 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Community
 menu: {main: {weight: 40}}
 ---
+<!-- mdformat on -->
 
 {{< blocks/section color="white" type="row" >}}
 
-{{% blocks/feature icon="fa-brands fa-github" title="Contribute" %}}
-Use [GitHub](https://github.com/google/heir) for pull requests. New users are always welcome!
-{{% /blocks/feature %}}
+{{% blocks/feature icon="fa-brands fa-github" title="Contribute" %}} Use
+[GitHub](https://github.com/google/heir) for pull requests. New users are always
+welcome! {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fa fa-comments" title="Discuss" %}}
-We use [GitHub issues](https://github.com/google/heir) for async developer discussions.
+{{% blocks/feature icon="fa fa-comments" title="Discuss" %}} We use
+[GitHub issues](https://github.com/google/heir) for async developer discussions.
 {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fa fa-people-group" title="Meet" %}}
-We have regular online meetings to discuss project direction.
-{{% /blocks/feature %}}
+{{% blocks/feature icon="fa fa-people-group" title="Meet" %}} We have regular
+online meetings to discuss project direction. {{% /blocks/feature %}}
 
 {{< /blocks/section >}}
diff --git a/docs/content/en/docs/Dialects/_index.md b/docs/content/en/docs/Dialects/_index.md
@@ -1,7 +1,9 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Dialects
 weight: 2
 ---
+<!-- mdformat on -->
 
 This section contains the reference documentation for all of the dialects
 defined in HEIR.
diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md
@@ -1,9 +1,11 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Documentation
 type: docs
 linkTitle: Docs
 menu: {main: {weight: 20}}
 weight: 20
 ---
+<!-- mdformat on -->
 
 This section is where the HEIR documentation lives.
diff --git a/docs/content/en/docs/getting_started.md b/docs/content/en/docs/getting_started.md
@@ -1,13 +1,15 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Getting Started
 weight: 1
 ---
+<!-- mdformat on -->
 
 ## Prerequisites
 
-- Git
-- Bazel
-- A C compiler (like gcc or clang)
+-   Git
+-   Bazel
+-   A C compiler (like gcc or clang)
 
 ## Clone and build the project
 

diff --git a/docs/content/en/docs/passes.md b/docs/content/en/docs/passes.md
@@ -1,7 +1,9 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Passes
 weight: 2
 ---
+<!-- mdformat on -->
 
 ## Memref Global Replace
 
@@ -11,6 +13,7 @@ It also requires that the affine load access indices are constants (i.e. not
 variadic or symbolic), so loops must be unrolled prior to this pass.
 
 Input
+
 ```
 module {
   memref.global "private" constant @__constant_8xi16 : memref<2x4xi16> = dense<[[-10, 20, 3, 4], [5, 6, 7, 8]]>
@@ -25,6 +28,7 @@ module {
 ```
 
 Output
+
 ```
 module {
   func.func @main() -> i16 {

diff --git a/docs/content/en/docs/pipelines.md b/docs/content/en/docs/pipelines.md
@@ -1,7 +1,9 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Pipelines
 weight: 3
 ---
+<!-- mdformat on -->
 
 The `--heir-tosa-to-arith` pipeline lowers a TOSA MLIR model to one that only
 contains arithmetic operations via a TOSA to `linalg` lowering path. As part of

diff --git a/docs/content/en/docs/tutorials.md b/docs/content/en/docs/tutorials.md
@@ -1,6 +1,8 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Tutorials
 weight: 10
 ---
+<!-- mdformat on -->
 
 A list of tutorials by the HEIR community.
diff --git a/docs/content/en/search.md b/docs/content/en/search.md
@@ -1,4 +1,6 @@
+<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Search Results
 layout: search
 ---
+<!-- mdformat on -->