Merge pull request google#937 from j2kun:markdown-formatter

PiperOrigin-RevId: 667670809
j2kun · Aug 26, 2024 · 0673a18 · 0673a18
2 parents a70bfb9 + 290c361
commit 0673a18
Show file tree

Hide file tree

Showing 50 changed files with 836 additions and 731 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-*   Using welcoming and inclusive language
-*   Being respectful of differing viewpoints and experiences
-*   Gracefully accepting constructive criticism
-*   Focusing on what is best for the community
-*   Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-*   The use of sexualized language or imagery and unwelcome sexual attention or
-    advances
-*   Trolling, insulting/derogatory comments, and personal or political attacks
-*   Public or private harassment
-*   Publishing others' private information, such as a physical or electronic
-    address, without explicit permission
-*   Other conduct which could reasonably be considered inappropriate in a
-    professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -51,3 +51,13 @@ repos:
     hooks:
       - id: actionlint
         additional_dependencies: [ pyflakes>=3.0.1, shellcheck-py>=0.9.0.5 ]
+
+# mdformat
+- repo: https://github.com/executablebooks/mdformat
+  rev: 0.7.17
+  hooks:
+  - id: mdformat
+    args: ["--wrap=80"]
+    additional_dependencies:
+    - mdformat-gfm
+    - mdformat-frontmatter
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -32,4 +32,5 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-Before contributing, please read [Contributing to HEIR](https://heir.dev/docs/contributing/).
+Before contributing, please read
+[Contributing to HEIR](https://heir.dev/docs/contributing/).
diff --git a/README.md b/README.md
@@ -16,22 +16,22 @@ For more information on MLIR, see the [MLIR homepage](https://mlir.llvm.org/).
 
 There are many ways to contribute to HEIR:
 
--   Come to our [twice-monthly meetings](https://heir.dev/community/) to discuss
-    active work on HEIR and future project directions. The meetings are recorded
-    and posted to our [blog](https://heir.dev/blog/)
--   Work on an issue marked
-    ["good first issue"](https://github.com/google/heir/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
-    or browse issues [labeled by topic](https://github.com/google/heir/labels).
--   Tell us about what you'd like to use HEIR for in an
-    [offline discussion thread](https://github.com/google/heir/discussions).
--   Help us understand new FHE research: either
-    -   Read a paper tagged under
-        [research synthesis](https://github.com/google/heir/labels/research%20synthesis)
-        and summarize the novel techniques that could be ported to HEIR.
-    -   File new issues under
-        [research synthesis](https://github.com/google/heir/labels/research%20synthesis)
-        to alert us of papers that should be investigated and incorporated into
-        HEIR.
+- Come to our [twice-monthly meetings](https://heir.dev/community/) to discuss
+  active work on HEIR and future project directions. The meetings are recorded
+  and posted to our [blog](https://heir.dev/blog/)
+- Work on an issue marked
+  ["good first issue"](https://github.com/google/heir/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+  or browse issues [labeled by topic](https://github.com/google/heir/labels).
+- Tell us about what you'd like to use HEIR for in an
+  [offline discussion thread](https://github.com/google/heir/discussions).
+- Help us understand new FHE research: either
+  - Read a paper tagged under
+    [research synthesis](https://github.com/google/heir/labels/research%20synthesis)
+    and summarize the novel techniques that could be ported to HEIR.
+  - File new issues under
+    [research synthesis](https://github.com/google/heir/labels/research%20synthesis)
+    to alert us of papers that should be investigated and incorporated into
+    HEIR.
 
 ## Support disclaimer
 

diff --git a/docs/README.md b/docs/README.md
@@ -4,65 +4,73 @@ This site uses [Hugo](https://gohugo.io/) with the
 [Docsy](https://www.docsy.dev/docs/) theme.
 
 ## Local Build
-In order to build the website locally, you will need to install `hugo` and `npm`.
-For example, on Ubuntu: `sudo apt-get install hugo npm`
 
-Note that `.github/workflows/docs.yml` installs a specific version of Hugo and Node,
-and it is likely that your system-provided version is not exactly the same.
-See the bottom of this README for instruction on
-how to install the exact versions in case you run into any errors.
+In order to build the website locally, you will need to install `hugo` and
+`npm`. For example, on Ubuntu: `sudo apt-get install hugo npm`
 
+Note that `.github/workflows/docs.yml` installs a specific version of Hugo and
+Node, and it is likely that your system-provided version is not exactly the
+same. See the bottom of this README for instruction on how to install the exact
+versions in case you run into any errors.
 
 1. Build the markdown files from the tablegen sources:
-    ```bash
-    bazel query "filter('_filegroup', siblings(kind('gentbl_rule', @heir//...)))" | xargs bazel build "$@"
-    ```
+
+   ```bash
+   bazel query "filter('_filegroup', siblings(kind('gentbl_rule', @heir//...)))" | xargs bazel build "$@"
+   ```
 
 1. Copy the markdown files to `docs/`:
-    ```bash
-    ./.github/workflows/copy_tblgen_files.sh
-    ```
+
+   ```bash
+   ./.github/workflows/copy_tblgen_files.sh
+   ```
 
 1. Navigate to the `/docs` directory:
-    ```bash
-    cd docs
-    ```
+
+   ```bash
+   cd docs
+   ```
 
 1. Use `npm` to install the dependencies:
-    ```bash
-    npm ci
-    ```
+
+   ```bash
+   npm ci
+   ```
 
 1. Run `hugo`:
-    ```bash
-    hugo server --minify
-    ```
 
+   ```bash
+   hugo server --minify
+   ```
 
 ### Matching Hugo and Node Version Exactly
-The website action [`.github/workflows/docs.yml`](https://github.com/google/heir/blob/main/.github/workflows/docs.yml)
-installs a specific version of Hugo and Node,
-and you should check there for the current versions to use:
 
-1. Install the Node Version Manager (`nvm`)
-   Follow the instructions at https://github.com/nvm-sh/nvm to download `nvm`.
-   For example:
+The website action
+[`.github/workflows/docs.yml`](https://github.com/google/heir/blob/main/.github/workflows/docs.yml)
+installs a specific version of Hugo and Node, and you should check there for the
+current versions to use:
+
+1. Install the Node Version Manager (`nvm`) Follow the instructions at
+   https://github.com/nvm-sh/nvm to download `nvm`. For example:
+
    ```bash
    wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
    ```
 
-1. Install the same Node version as used in the workflow, for example:
-   ``bash
+1. Install the same Node version as used in the workflow, for example: \`\`bash
    nvm install 18
+
    ```
 
-1. Install the Hugo dependencies, minimally `golang`.
-   For example, on Ubuntu: `sudo apt-get install golang`
+   ```
+
+1. Install the Hugo dependencies, minimally `golang`. For example, on Ubuntu:
+   `sudo apt-get install golang`
+
+1. Download the matching release from GitHub. The release page
+   (https://github.com/gohugoio/hugo/releases/tag/v0.113.0) provides several
+   versions, pick the *extended* version for your system. For example:
 
-1. Download the matching release from GitHub.
-   The release page (https://github.com/gohugoio/hugo/releases/tag/v0.113.0)
-   provides several versions, pick the *extended* version for your system.
-   For example:
    ```bash
    mkdir docs/hugo && cd docs/hugo
    wget https://github.com/gohugoio/hugo/releases/download/v0.113.0/hugo_extended_0.113.0_linux-amd64.tar.gz
@@ -71,6 +79,7 @@ and you should check there for the current versions to use:
    ```
 
 1. Follow the instructions above, except for the last step (running Hugo):
-    ```bash
-    ./hugo/hugo server --minify
-    ```
+
+   ```bash
+   ./hugo/hugo server --minify
+   ```
diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md
@@ -1,22 +1,20 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
-title: "HEIR: Homomorphic Encryption Intermediate Representation"
+title: 'HEIR: Homomorphic Encryption Intermediate Representation'
 linkTitle: Home
 menu: {main: {weight: 1}}
 weight: 1
 
 cascade:
-  - type: "blog"
+  - type: blog
     # Comment this to make blog appear in the main sidebar nav.
     # It shows all blog posts expanded, and is too long.
     toc_root: true
     _target:
-      path: "/blog/**"
-  - type: "docs"
+      path: /blog/**
+  - type: docs
     _target:
-      path: "/**"
+      path: /**
 ---
-<!-- mdformat on -->
 
 ## What is HEIR?
 
@@ -29,26 +27,26 @@ privacy-first software systems.
 
 HEIR is built in the [MLIR](https://mlir.llvm.org/) framework.
 
-For an overview of the project's goals, see [our talk at
-FHE.org](https://www.youtube.com/watch?v=kqDFdKUTNA4).
+For an overview of the project's goals, see
+[our talk at FHE.org](https://www.youtube.com/watch?v=kqDFdKUTNA4).
 
-To see the dialects and possible flows, take a look at the diagram below:
-{{< figure src="/images/dialects.svg" link="/images/dialects.svg" >}}
+To see the dialects and possible flows, take a look at the diagram below: {{\<
+figure src="/images/dialects.svg" link="/images/dialects.svg" >}}
 
 ## Project Goals
 
--   Provide MLIR dialects for all modern FHE schemes.
--   Design MLIR dialects that appropriately abstract across the many flavors of
-    related schemes.
--   Design lower-level dialects for optimizing underlying abstract-algebraic
-    operations (e.g., modular polynomial arithmetic).
--   Provide hardware accelerator designers an easy path to integrate, so that a
-    wide variety of FHE programs, optimizations, and parameter choices can be
-    compared across accelerators.
--   Provide a platform for research into novel FHE optimizations.
--   Provide a platform for benchmarking.
--   Provide integrations with multiple front-end languages, such as ClangIR and
-    TensorFlow.
+- Provide MLIR dialects for all modern FHE schemes.
+- Design MLIR dialects that appropriately abstract across the many flavors of
+  related schemes.
+- Design lower-level dialects for optimizing underlying abstract-algebraic
+  operations (e.g., modular polynomial arithmetic).
+- Provide hardware accelerator designers an easy path to integrate, so that a
+  wide variety of FHE programs, optimizations, and parameter choices can be
+  compared across accelerators.
+- Provide a platform for research into novel FHE optimizations.
+- Provide a platform for benchmarking.
+- Provide integrations with multiple front-end languages, such as ClangIR and
+  TensorFlow.
 
 ## Partners
 

diff --git a/docs/content/en/blog/_index.md b/docs/content/en/blog/_index.md
@@ -1,8 +1,6 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
 title: Blog
 weight: 100
 linkTitle: Blog
 menu: {main: {weight: 30}}
 ---
-<!-- mdformat on -->
diff --git a/docs/content/en/blog/heir_meeting_2023-06-27.md b/docs/content/en/blog/heir_meeting_2023-06-27.md
@@ -1,13 +1,11 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
-title: "HEIR meeting 2023-06-30"
+title: HEIR meeting 2023-06-30
 date: 2023-06-30T12:42:22-07:00
-linkTitle: "HEIR meeting 2023-06-27"
+linkTitle: HEIR meeting 2023-06-27
 description: >
-    Notes and recording from the second HEIR meeting.
-author: "[Jeremy Kun](https://jeremykun.com)"
+  Notes and recording from the second HEIR meeting.
+author: '[Jeremy Kun](https://jeremykun.com)'
 ---
-<!-- mdformat on -->
 
 The second HEIR meeting was 2023-05-30
 ([notes](https://docs.google.com/document/d/1wxaEtpEDdO2yv5YKmFTc8FVlqHxm49gHzEdcnBFBKWs/edit?usp=sharing),
@@ -18,6 +16,6 @@ There are some initial design discussion threads started on
 [GitHub Discussions](https://github.com/google/heir/discussions) to get the
 design rolling.
 
--   [High-Level FHE Dialect](https://github.com/google/heir/discussions/53)
--   [Scheme Dialects](https://github.com/google/heir/discussions/54)
--   [Poly/Math Dialects](https://github.com/google/heir/discussions/55)
+- [High-Level FHE Dialect](https://github.com/google/heir/discussions/53)
+- [Scheme Dialects](https://github.com/google/heir/discussions/54)
+- [Poly/Math Dialects](https://github.com/google/heir/discussions/55)
diff --git a/docs/content/en/blog/heir_meeting_2023-07-18.md b/docs/content/en/blog/heir_meeting_2023-07-18.md
@@ -1,18 +1,16 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
-title: "HEIR meeting 2023-07-18"
+title: HEIR meeting 2023-07-18
 date: 2023-07-18T10:43:16-0700
-linkTitle: "HEIR meeting 2023-07-18"
+linkTitle: HEIR meeting 2023-07-18
 description: >
-    Notes from the 2023-07-18 HEIR meeting.
-author: "[Jeremy Kun](https://jeremykun.com)"
+  Notes from the 2023-07-18 HEIR meeting.
+author: '[Jeremy Kun](https://jeremykun.com)'
 ---
-<!-- mdformat on -->
 
 The third HEIR meeting was 2023-07-18
 ([notes](https://docs.google.com/document/d/1DXdyUCmevqY8RJI3kM8oO5nWDEITFIVBPIbucONOB-k/edit?usp=sharing)).
 
 We decided to schedule future meetings every two weeks, with alternating focus
-on MLIR and Hardware. See the
-[meeting calendar](https://heir.dev/community/) to join.
+on MLIR and Hardware. See the [meeting calendar](https://heir.dev/community/) to
+join.
 ([direct link to the calendar](https://calendar.google.com/calendar/u/0/embed?src=c85ecb3cda4bfb7daa3da95d5aeb19672930501b49d17896e65fa3f963f17a80@group.calendar.google.com&ctz=America/Los_Angeles))
diff --git a/docs/content/en/blog/heir_meeting_2023-08-01.md b/docs/content/en/blog/heir_meeting_2023-08-01.md
@@ -1,13 +1,11 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
-title: "HEIR meeting 2023-08-01"
+title: HEIR meeting 2023-08-01
 date: 2023-08-02T15:46:42-0700
-linkTitle: "HEIR meeting 2023-08-01"
+linkTitle: HEIR meeting 2023-08-01
 description: >
-    Notes from the 2023-08-01 HEIR meeting.
-author: "[Jeremy Kun](https://jeremykun.com)"
+  Notes from the 2023-08-01 HEIR meeting.
+author: '[Jeremy Kun](https://jeremykun.com)'
 ---
-<!-- mdformat on -->
 
 The fourth HEIR meeting was 2023-08-01
 ([notes](https://docs.google.com/document/d/1gid-MARMUStb3dB9jsXEV_CnPDpf_9cyPXy9uXtZk08/edit?usp=sharing)

diff --git a/docs/content/en/blog/heir_meeting_2023-08-15.md b/docs/content/en/blog/heir_meeting_2023-08-15.md
@@ -1,13 +1,11 @@
-<!-- mdformat off(yaml frontmatter) -->
 ---
-title: "HEIR meeting 2023-08-15"
+title: HEIR meeting 2023-08-15
 date: 2023-08-16T16:15:47+00:00
-linkTitle: "HEIR meeting 2023-08-15"
+linkTitle: HEIR meeting 2023-08-15
 description: >
-    Notes from the 2023-08-15 HEIR meeting.
-author: "[Jeremy Kun](https://jeremykun.com)"
+  Notes from the 2023-08-15 HEIR meeting.
+author: '[Jeremy Kun](https://jeremykun.com)'
 ---
-<!-- mdformat on -->
 
 Here are the
 [notes](https://docs.google.com/document/d/1vZsKJH4wCAZCtyh3o9nNMLRFwlWQiVdvUMvwJnA4cIc/edit?usp=sharing)