Improve contributing.md file

- Add GitHub flow instructions - Correct port information - Use appropriate Markdown features
FabricMC · Jun 27, 2024 · 3d4917e · 3d4917e
1 parent f612b05
commit 3d4917e
Show file tree

Hide file tree

Showing 11 changed files with 377 additions and 255 deletions.
diff --git a/contributing.md b/contributing.md
diff --git a/translated/de_de/contributing.md b/translated/de_de/contributing.md
@@ -1,6 +1,6 @@
 # Richtlinien zur Beitragserstellung für die Fabric-Dokumentation
 
-Diese Website nutzt [VitePress](https://vitepress.dev/) um statisches HTML von den verschiedenen Markdown-Dateien zu generrieren. Du solltest dich mit den Markdown-Erweiterungen vertraut machen, die VitePress [hier](https://vitepress.dev/guide/markdown.html#features) unterstützt.
+Diese Website nutzt [VitePress](https://vitepress.dev/) um statisches HTML von den verschiedenen Markdown-Dateien zu generrieren. Du solltest dich mit den Markdown-Erweiterungen vertraut machen, die VitePress [hier](https://vitepress.dev/guide/markdown#features) unterstützt.
 
 ## Inhaltsverzeichnis
 
@@ -26,23 +26,23 @@ Bevor du einen dieser Befehle ausführst, solltest du `npm install` ausführen,
 
 Damit kannst du deine Änderungen lokal auf `localhost:3000` ansehen und die Seite wird automatisch neu geladen, wenn du Änderungen vornimmst.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Erstellung der Website:**
 
 Dies wird alle Markdown-Dateien in statische HTML-Dateien kompilieren und diese in `.vitepress/dist` ablegen
 
-```bash
+```sh
 npm run build
 ```
 
 **Vorschau auf die erstellte Website:**
 
 Dies wird einen lokalen Server auf Port 3000 starten, der den Inhalt in `.vitepress/dist` bereitstellt.
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/es_es/contributing.md b/translated/es_es/contributing.md
@@ -1,6 +1,6 @@
 # Pautas de Contribución para la Documentación de Fabric
 
-Esta página web utiliza [VitePress](https://vitepress.vuejs.org/) para generar HTML estático a partir de varios archivos markdown. Debes familiarizarte con las extensiones de markdown que VitePress soporta [aquí.](https://vitepress.vuejs.org/guide/markdown.html#features)
+Esta página web utiliza [VitePress](https://vitepress.dev/) para generar HTML estático a partir de varios archivos markdown. Debes familiarizarte con las extensiones de markdown que VitePress soporta [aquí](https://vitepress.dev/guide/markdown#features).
 
 ## Índice de Contenido
 
@@ -26,23 +26,23 @@ Antes de correr cualquiera de estos comandos, asegúrate de correr `npm install`
 
 Esto te permitirá ver una vista previa de tus cambios localmente en `localhost:3000`.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Construyendo la página web:**
 
 Esto compilará todos los archivos markdown en archivos HTML estáticos, los cuales estarán en `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **Viendo la vista previa de la página web:**
 
 Esto ejecutará un servidor local en el puerto 3000 usando el contenido encontrado en `.vitepress/dist`
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/it_it/contributing.md b/translated/it_it/contributing.md
diff --git a/translated/ko_kr/contributing.md b/translated/ko_kr/contributing.md
@@ -1,6 +1,6 @@
 # Fabric 문서 기여 가이드라인
 
-이 웹사이트는 [VitePress](https://vitepress.dev/)를 사용해 다양한 마크다운 파일에서 정적 HTML을 생성합니다. [여기](https://vitepress.dev/guide/markdown.html#features)에서 VitePress가 지원하는 마크다운 확장 기능에 익숙해져야 합니다.
+이 웹사이트는 [VitePress](https://vitepress.dev/)를 사용해 다양한 마크다운 파일에서 정적 HTML을 생성합니다. [여기](https://vitepress.dev/guide/markdown#features)에서 VitePress가 지원하는 마크다운 확장 기능에 익숙해져야 합니다.
 
 ## 목차
 
@@ -26,23 +26,23 @@
 
 개발 서버는 `localhost:3000`에서 로컬 변경 사항을 미리 볼 수 있게 합니다. 코드가 변경되면 변경 사항을 자동으로 적용합니다.
 
-```bash
+```sh
 npm run dev
 ```
 
 **웹사이트 빌드하기**
 
 웹사이트를 빌드하면 모든 마크다운 파일이 정적 HTML로 컴파일되어 `.vitepress/dist` 에 저장됩니다.
 
-```bash
+```sh
 npm run build
 ```
 
 **빌드된 웹사이트 미리 보기**
 
 `.vitepress/dist`에 저장된 콘텐츠를 `localhost:3000` 에서 볼 수 있도록 합니다.
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/pt_br/contributing.md b/translated/pt_br/contributing.md
@@ -1,6 +1,6 @@
 # Diretrizes de Contribuição da Documentação do Fabric
 
-Este site usa [VitePress](https://vitepress.dev/) para gerar HTML estático de vários arquivos do Markdown. Você deve estar familiarizado com as extensões Markdown que o VitePress suporta [aqui.](https://vitepress.dev/guide/markdown.html#features)
+Este site usa [VitePress](https://vitepress.dev/) para gerar HTML estático de vários arquivos do Markdown. Você deve estar familiarizado com as extensões Markdown que o VitePress suporta [aqui](https://vitepress.dev/guide/markdown#features).
 
 ## Sumário
 
@@ -26,23 +26,23 @@ Antes de executar alguns desses comandos, certifique-se de executar `npm install
 
 Isso vai permitir que você visualize as alterações localmente em: `localhost:3000` e recarregará automaticamente a página quando você fizer alterações.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Fazendo o Website.**
 
 Isto irá compilar todos os arquivos Markdown em arquivos HTML estáticos e colocá-los em: `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **Visualizando o Site Feito.**
 
 Isso iniciará um servidor local na porta 3000 servindo o conteúdo encontrado em `.vitepress/dist`
 
-```bash
+```sh
 npm run preview
 ```
 
@@ -71,7 +71,7 @@ As diretrizes a serem seguidas:
    ```md
    ---
    título: Esse é o Título da Pagina
-   Descrição: Essa é a descrição da página 
+   Descrição: Essa é a descrição da página
    autores:
      - NomeAleatórioDoGitHub
    ---
@@ -127,7 +127,7 @@ As diretrizes a serem seguidas:
    ```java
    public void test() {
      System.out.println("Olá Mundo!");
-   } 
+   }
    ```
 
 3. A documentação original inteira é escrita em Inglês, seguindo as regras da gramática Estadunidense. Embora você possa usar o [LanguageTool](https://languagetool.org/) para verificar sua gramática enquanto digita,mas não se encuque muito com isso. Nossa equipe de documentação revisará e corrigirá a gramática durante a fase de revisão. No entanto, se esforçar para acertar inicialmente pode nos poupar um bom tempo.

diff --git a/translated/ru_ru/contributing.md b/translated/ru_ru/contributing.md
@@ -1,6 +1,6 @@
 # Руководство по внесению вклада в документацию Fabric
 
-Этот сайт использует [VitePress](https://vitepress.dev/) для генерации статического HTML-кода из различных Markdown-файлов. Вы можете ознакомиться с Markdown-расширениями для VitePress [здесь](https://vitepress.dev/guide/markdown.html#features).
+Этот сайт использует [VitePress](https://vitepress.dev/) для генерации статического HTML-кода из различных Markdown-файлов. Вы можете ознакомиться с Markdown-расширениями для VitePress [здесь](https://vitepress.dev/guide/markdown#features).
 
 ## Содержание
 
@@ -26,23 +26,23 @@
 
 Это позволит вам предварительно просматривать ваши изменения локально по адресу `localhost:3000` и автоматически перезагрузит страницу при внесении изменений.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Компиляция веб-сайта:**
 
 Это преобразует все файлы Markdown в статические HTML-файлы и разместит их в папке `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **Предварительный просмотр собранного веб-сайта:**
 
 Это запустит локальный сервер на порту 3000, отображающий содержимое, найденное в `.vitepress/dist`
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/uk_ua/contributing.md b/translated/uk_ua/contributing.md
@@ -1,6 +1,6 @@
 # Правила внесення внесків до документації Fabric
 
-Цей вебсайт використовує [VitePress](https://vitepress.dev/) для генерації статичного HTML з різних файлів Markdown. Вам слід ознайомитися з розширеннями Markdown, які підтримує VitePress, [тут.](https://vitepress.dev/guide/markdown.html#features)
+Цей вебсайт використовує [VitePress](https://vitepress.dev/) для генерації статичного HTML з різних файлів Markdown. Вам слід ознайомитися з розширеннями Markdown, які підтримує VitePress, [тут](https://vitepress.dev/guide/markdown#features).
 
 ## Зміст
 
@@ -26,23 +26,23 @@
 
 Це дозволить вам переглянути свої зміни локально за адресою `localhost:3000` і автоматично перезавантажить сторінку при внесенні змін.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Побудова вебсайту:**
 
 Це скомпілює всі файли Markdown у статичні HTML-файли та помістить їх у папку `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **Перегляд побудованого вебсайту:**
 
 Це запустить локальний сервер на порту 3000, який буде обслуговувати вміст, знайдений у папці `.vitepress/dist`
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/vi_vn/contributing.md b/translated/vi_vn/contributing.md
@@ -1,6 +1,6 @@
 # Tài Liệu Hướng Dẫn Cách Đóng Góp Fabric
 
-Trang này sử dụng [VitePress](https://vitepress.vuejs.org/) để tạo văn bản HTML tĩnh từ nhiều tệp markdown khác nhau. Bạn nên làm quen với những tiện ích markdown mà VitePress hỗ trợ tại [đây.](https://vitepress.vuejs.org/guide/markdown.html#features)
+Trang này sử dụng [VitePress](https://vitepress.dev/) để tạo văn bản HTML tĩnh từ nhiều tệp markdown khác nhau. Bạn nên làm quen với những tiện ích markdown mà VitePress hỗ trợ tại [đây](https://vitepress.dev/guide/markdown#features).
 
 ## Mục Lục
 
@@ -25,23 +25,23 @@ Trước khi chạy bất kì lệnh nào, hãy đảm bảo chạy lệnh `npm
 
 Điều này sẽ cho phép bạn xem trước các thay đổi bạn đã làm trên thiết bị của bạn tại địa chỉ `localhost:3000` và sẽ tự động tải lại trang khi bạn thực hiện các thay đổi.
 
-```bash
+```sh
 npm run dev
 ```
 
 **Xây dựng trang web:**
 
 Lệnh dưới đây sẽ biên dịch toàn bộ tập tin markdown thành những tệp HTML tĩnh và đặt chúng trong `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **Xem trước trang web đã tạo:**
 
 Lệnh dưới sẽ khởi động một máy chủ nội bộ trên cổng 3000 để hiển thị nội dụng được tìm thấy ở `.vitepress/dist`
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/zh_cn/contributing.md b/translated/zh_cn/contributing.md
@@ -1,6 +1,6 @@
 # Fabric 文档贡献指南
 
-此网站使用 [VitePress](https://vitepress.dev/) 从多个 Markdown 文件生成静态 HTML 网页。 您应该熟悉 VitePress 所支持的 Markdown 扩展语法，参见[此链接](https://vitepress.dev/guide/markdown.html#features)。
+此网站使用 [VitePress](https://vitepress.dev/) 从多个 Markdown 文件生成静态 HTML 网页。 您应该熟悉 VitePress 所支持的 Markdown 扩展语法，参见[此链接](https://vitepress.dev/guide/markdown#features)。
 
 ## 目录
 
@@ -26,23 +26,23 @@
 
 这将允许您在本地地址 `localhost:3000` 预览您的更改，并自动在修改时重载页面。
 
-```bash
+```sh
 npm run dev
 ```
 
 **构建网站：**
 
 这将编译所有 Markdown 文件为静态 HTML 页面并保存至 `.vitepress/dist`
 
-```bash
+```sh
 npm run build
 ```
 
 **预览已构建的网站：**
 
 这将在端口 3000 启动本地服务器并展示 `.vitepress/dist` 中的网页
 
-```bash
+```sh
 npm run preview
 ```
 

diff --git a/translated/zh_tw/contributing.md b/translated/zh_tw/contributing.md
@@ -1,6 +1,6 @@
 # Fabric 文件貢獻指南
 
-這個網站使用 [VitePress](https://vitepress.dev/) 來將各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.vuejs.org/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.vuejs.org/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.vuejs.org/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.vuejs.org/) 來從各種 Markdown 檔案轉換成靜態 HTML。 你應該熟悉 VitePress 支援的 Markdown 擴充功能，詳細內容請參閱[這裡](https://vitepress.vuejs.org/guide/markdown.html#features)。
+這個網站使用 [VitePress](https://vitepress.dev/) 來將各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.dev/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.dev/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.dev/) 來從各種 Markdown 檔案轉換成靜態 HTML。 這個網站使用 [VitePress](https://vitepress.dev/) 來從各種 Markdown 檔案轉換成靜態 HTML。 你應該熟悉 VitePress 支援的 Markdown 擴充功能，詳細內容請參閱[這裡](https://vitepress.dev/guide/markdown#features)。
 
 ## 目錄
 
@@ -26,23 +26,23 @@
 
 這將讓你能在本機預覽你的變更，網址是 `localhost:3000`，並且在你進行變更時會自動重新載入頁面。
 
-```bash
+```sh
 npm run dev
 ```
 
 **建構網站：**
 
 這將把所有的 Markdown 檔案編譯成靜態 HTML 檔案，並將它們放置在 `.vitepress/dist` 資料夾中。
 
-```bash
+```sh
 npm run build
 ```
 
 **預覽已建置的網站：**
 
 這將在連接埠 3000 上啟動本機伺服器，提供在 `.vitepress/dist` 中找到的內容。
 
-```bash
+```sh
 npm run preview
 ```