chore(docs): format mdx files with remark

`prettier` doesn't not have proper support for MDX v3. Docusaurus recommends using `remark` instead. https://docusaurus.io/docs/markdown-features/react re #503
semaphore-protocol · Apr 26, 2024 · c4cb471 · c4cb471
1 parent c5448fe
commit c4cb471
Show file tree

Hide file tree

Showing 23 changed files with 1,222 additions and 925 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -34,7 +34,7 @@
 -   [ ] I have commented my code, particularly in hard-to-understand areas
 -   [ ] I have made corresponding changes to the documentation
 -   [ ] My changes generate no new warnings
--   [ ] I have run `yarn prettier` and `yarn lint` without getting any errors
+-   [ ] I have run `yarn format` and `yarn lint` without getting any errors
 -   [ ] I have added tests that prove my fix is effective or that my feature works
 -   [ ] New and existing unit tests pass locally with my changes
 -   [ ] Any dependent changes have been merged and published in downstream modules
diff --git a/.github/workflows/pull-requests.yml b/.github/workflows/pull-requests.yml
@@ -31,8 +31,8 @@ jobs:
             - name: Build subgraph
               run: yarn build:subgraph
 
-            - name: Run Prettier
-              run: yarn prettier
+            - name: Format
+              run: yarn format
 
             - name: Run Eslint
               run: yarn lint

diff --git a/README.md b/README.md
@@ -295,13 +295,13 @@ yarn lint
 Run [Prettier](https://prettier.io/) to check formatting rules:
 
 ```bash
-yarn prettier
+yarn format
 ```
 
 Or to automatically format the code:
 
 ```bash
-yarn prettier:write
+yarn format:write
 ```
 
 ### Conventional commits

diff --git a/...docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/fetching-data.mdx b/...docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/fetching-data.mdx
@@ -18,34 +18,31 @@ Hay dos formas para hacer esto, usando [`SemaphoreSubgraph`](https://github.com/
 ## Instalar librería
 
 <Tabs
-defaultValue="npm"
-groupId="package-managers"
-values={[
+  defaultValue="npm"
+  groupId="package-managers"
+  values={[
 {label: 'npm', value: 'npm'},
 {label: 'Yarn', value: 'yarn'},
 {label: 'pnpm', value: 'pnpm'}
-]}>
-<TabItem value="npm">
-
-```bash
-npm install @semaphore-protocol/data@^3
-```
-
-</TabItem>
-<TabItem value="yarn">
-
-```bash
-yarn add @semaphore-protocol/data@^3
-```
-
-</TabItem>
-<TabItem value="pnpm">
-
-```bash
-pnpm add @semaphore-protocol/data@^3
-```
-
-</TabItem>
+]}
+>
+  <TabItem value="npm">
+    ```bash
+    npm install @semaphore-protocol/data@^3
+    ```
+  </TabItem>
+
+  <TabItem value="yarn">
+    ```bash
+    yarn add @semaphore-protocol/data@^3
+    ```
+  </TabItem>
+
+  <TabItem value="pnpm">
+    ```bash
+    pnpm add @semaphore-protocol/data@^3
+    ```
+  </TabItem>
 </Tabs>
 
 ## Obtener datos usando SemaphoreSubgraph
@@ -113,6 +110,7 @@ const semaphoreSubgraph = new SemaphoreSubgraph("sepolia")
 const { members } = await semaphoreSubgraph.getGroup(groupId, { members: true })
 const group = new Group(groupId, 20, members)
 ```
+
 :::
 
 ## Obtener datos usando SemaphoreEthers
@@ -178,4 +176,5 @@ const semaphoreEthers = new SemaphoreEthers("sepolia")
 const members = await semaphoreEthers.getGroupMembers(groupId)
 const group = new Group(groupId, 20, members)
 ```
+
 :::
diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/groups.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/groups.mdx
@@ -11,78 +11,75 @@ import TabItem from "@theme/TabItem"
 Un [grupo Semaphore](/V3/glossary/#grupo-semaphore) contiene los [identity commitments](/V3/glossary/#compromiso-de-identidad-identity-commitment) (compromisos de identidad) de miembros del grupo.
 Estos son algunos ejemplos de uso de los grupos:
 
--   Encuesta con preguntas a la que se unen las personas que acudieron a un evento para calificarlo,
--   votación a la que se unen los miembros para votar por una propuesta,
--   Denunciantes que están verificados como empleados de una organización.
+- Encuesta con preguntas a la que se unen las personas que acudieron a un evento para calificarlo,
+- votación a la que se unen los miembros para votar por una propuesta,
+- Denunciantes que están verificados como empleados de una organización.
 
 Un grupo Semaphore es un [árbol de Merkle incremental](/V3/glossary/#árbol-de-merkle-merkle-tree), y los miembros del grupo (por ejemplo, [identity commitments](/V3/glossary/#compromiso-de-identidad-identity-commitment)) son las hojas del árbol.
 Los grupos Semaphore determinan los siguientes tres parámetro:
 
--   **Group id**: un identificador único para el grupo;
--   **Tree depth**: el número máximo de miembros que puede contener un grupo (`max size = 2 ^ tree depth`);
--   **Members** la lista de miembros para inicializar el grupo.
+- **Group id**: un identificador único para el grupo;
+- **Tree depth**: el número máximo de miembros que puede contener un grupo (`max size = 2 ^ tree depth`);
+- **Members** la lista de miembros para inicializar el grupo.
 
 Aprenda cómo trabajar con grupos.
 
--   [**Grupos off-chain**](#grupos-off-chain-externos-a-la-cadena)
--   [**Grupos on-chain**](#grupos-on-chain)
+- [**Grupos off-chain**](#grupos-off-chain-externos-a-la-cadena)
+- [**Grupos on-chain**](#grupos-on-chain)
 
 ## Grupos off-chain (externos a la cadena)
 
--   [Crear un grupo](#crear-un-grupo)
--   [Añadir miembros](#añadir-miembros)
--   [Remover o actualizar miembros](#remover-o-actualizar-miembros)
+- [Crear un grupo](#crear-un-grupo)
+- [Añadir miembros](#añadir-miembros)
+- [Remover o actualizar miembros](#remover-o-actualizar-miembros)
 
 ### Crear un grupo
 
 Utilice la clase `Group` de la librería [`@semaphore-protocol/group`](https://github.com/semaphore-protocol/semaphore/blob/main/packages/group) para crear un grupo off-chain con los siguientes parámetros:
 
--   `Group id`: un identificar único para el grupo;
--   `Tree depth`: (_default `20`_) el número máximo de usuarios que puede contener un grupo, el valor por defecto es 20 (`max size = 2 ^ tree depth`).
--   `Members`: (_default `[]`_) la lista de miembros para inicializar el grupo.
+- `Group id`: un identificar único para el grupo;
+- `Tree depth`: (*default `20`*) el número máximo de usuarios que puede contener un grupo, el valor por defecto es 20 (`max size = 2 ^ tree depth`).
+- `Members`: (*default `[]`*) la lista de miembros para inicializar el grupo.
 
 #### Instalar librería:
 
 <Tabs
-defaultValue="npm"
-groupId="package-managers"
-values={[
+  defaultValue="npm"
+  groupId="package-managers"
+  values={[
 {label: 'npm', value: 'npm'},
 {label: 'Yarn', value: 'yarn'},
 {label: 'pnpm', value: 'pnpm'}
-]}>
-<TabItem value="npm">
-
-```bash
-npm install @semaphore-protocol/group@^3
-```
-
-</TabItem>
-<TabItem value="yarn">
-
-```bash
-yarn add @semaphore-protocol/group@^3
-```
-
-</TabItem>
-<TabItem value="pnpm">
-
-```bash
-pnpm add @semaphore-protocol/group@^3
-```
-
-</TabItem>
+]}
+>
+  <TabItem value="npm">
+    ```bash
+    npm install @semaphore-protocol/group@^3
+    ```
+  </TabItem>
+
+  <TabItem value="yarn">
+    ```bash
+    yarn add @semaphore-protocol/group@^3
+    ```
+  </TabItem>
+
+  <TabItem value="pnpm">
+    ```bash
+    pnpm add @semaphore-protocol/group@^3
+    ```
+  </TabItem>
 </Tabs>
 
-Para crear un grupo con el número de usuarios que aparece por defecto (20) _`treeDepth`_, llame la función para construir un `Group` sin el segundo parámetro. Por ejemplo:
+Para crear un grupo con el número de usuarios que aparece por defecto (20) *`treeDepth`*, llame la función para construir un `Group` sin el segundo parámetro. Por ejemplo:
 
 ```ts
 import { Group } from "@semaphore-protocol/group"
 
 const group = new Group(1)
 ```
 
-El siguiente código de ejemplo pasa por _`treeDepth`_ para crear un grupo para `2 ^ 30 = 1073741824` miembros:
+El siguiente código de ejemplo pasa por *`treeDepth`* para crear un grupo para `2 ^ 30 = 1073741824` miembros:
 
 ```ts
 import { Group } from "@semaphore-protocol/group"

diff --git a/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/identities.mdx b/apps/docs/i18n/es/docusaurus-plugin-content-docs/version-V3/guides/identities.mdx
@@ -11,48 +11,47 @@ import TabItem from "@theme/TabItem"
 Para unirse a un [grupo Semaphore](/V3/glossary#grupo-semaphore), un usuario primero deberá crear una [identidad Semaphore](/V3/glossary#identidad-semaphore).
 Una identidad Semaphore contiene dos valores generados junto con la identidad:
 
--   Identity trapdoor (Identidad trampilla)
--   Identity nullifier (Anulador de identidad)
+- Identity trapdoor (Identidad trampilla)
+- Identity nullifier (Anulador de identidad)
 
 Para utilizar y verificar su identidad, la persona dueña de la identidad (usuario) debe conocer los valores trapdoor y nullifier.
 Para prevenir fraudes, la persona dueña debe conservar de forma secreta ambos valores.
 
 ## Crear identidades
 
-En su código, utilice la librería [`@semaphore-protocol/identity`](https://github.com/semaphore-protocol/semaphore/tree/main/packages/identity) para crear una identidad Semaphore _de forma determinística_ (del hash de un mensaje) o _de forma aleatoria_.
+En su código, utilice la librería [`@semaphore-protocol/identity`](https://github.com/semaphore-protocol/semaphore/tree/main/packages/identity) para crear una identidad Semaphore *de forma determinística* (del hash de un mensaje) o *de forma aleatoria*.
 
--   [**Crear identidades aleatorias**](#crear-identidades-aleatorias)
--   [**Crear identidades determinísticas**](#crear-identidades-determinísticas)
+- [**Crear identidades aleatorias**](#crear-identidades-aleatorias)
+- [**Crear identidades determinísticas**](#crear-identidades-determinísticas)
 
 ### Instalar librería:
 
 <Tabs
-defaultValue="npm"
-groupId="package-managers"
-values={[
+  defaultValue="npm"
+  groupId="package-managers"
+  values={[
 {label: 'npm', value: 'npm'},
 {label: 'Yarn', value: 'yarn'},
 {label: 'pnpm', value: 'pnpm'}
-]}>
-<TabItem value="npm">
-
-```bash
-npm install @semaphore-protocol/identity@^3
-```
-</TabItem>
-<TabItem value="yarn">
-```bash
-yarn add @semaphore-protocol/identity@^3
-```
-
-</TabItem>
-<TabItem value="pnpm">
-
-```bash
-pnpm add @semaphore-protocol/identity@^3
-```
-
-</TabItem>
+]}
+>
+  <TabItem value="npm">
+    ```bash
+    npm install @semaphore-protocol/identity@^3
+    ```
+  </TabItem>
+
+  <TabItem value="yarn">
+    ```bash
+    yarn add @semaphore-protocol/identity@^3
+    ```
+  </TabItem>
+
+  <TabItem value="pnpm">
+    ```bash
+    pnpm add @semaphore-protocol/identity@^3
+    ```
+  </TabItem>
 </Tabs>
 
 ### Crear identidades aleatorias
@@ -67,8 +66,8 @@ const { trapdoor, nullifier, commitment } = new Identity()
 
 La nueva identidad contiene dos valores aleatorios secretos: `trapdoor` y `nullifier`, y un valor público: `commitment`.
 
-El hash Poseidon del identity nullifier y trapdoor se conoce como _identity secret_ (el secreto de identidad),
-y su hash es el _identity commitment_ (compromiso de identidad).
+El hash Poseidon del identity nullifier y trapdoor se conoce como *identity secret* (el secreto de identidad),
+y su hash es el *identity commitment* (compromiso de identidad).
 
 Un identity commitment (compromiso de identidad), de forma similar a las direcciones Ethereum, es un valor público que se utiliza en los grupos Semaphore para representar la
 identidad de un miembro del grupo. Los valores secretos son similares a las llaves privadas
@@ -77,7 +76,7 @@ Ethereum y se utilizan para generar pruebas de conocimiento cero (ZKP) Semaphore
 ### Crear identidades determinísticas
 
 Si transmite un mensaje como un parámetro, Semaphore genera `trapdoor` y `nullifier`
-del hash _SHA256_ del mensaje.
+del hash *SHA256* del mensaje.
 El mensaje puede ser una contraseña o un mensaje que el usuario firma de forma criptográfica con una llave privada.
 
 Al utilizar identidades determinísticas siempre deberá mantener secreto el mensaje.