Skip to content

Commit d323adb

Browse files
authored
docs: change READMEs to be more consistent for different languages (#6696)
## 📝 Summary Edit all of the README files to be more consistent across languages. ## 🔍 Description of Changes 1. Make indentation/spacing more consistent 2. Add missing `</p>` tag 3. Make Spanish README list the languages in their respective spelling (instead of Spanish for all of them). This is consistent with the other README files 4. Break up "nav-bar" HTML so that the `<b> | </b>` separators are between every language - This makes it easier to keep the README files in sync, because if you switch between them, the only difference is which languages are wrapped by an `<a>` tag (also helped by change 3) 5. Fix outdated links in Chinese and Spanish README files ## 📋 Checklist - [x] I have read the [contributor guidelines](https://github.com/marimo-team/marimo/blob/main/CONTRIBUTING.md). - [x] For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on [Discord](https://marimo.io/discord?ref=pr), or the community [discussions](https://github.com/marimo-team/marimo/discussions). - N/A - [x] I have added tests for the changes made. - N/A - [x] I have run the code and verified that it works as expected. - N/A
1 parent fb60424 commit d323adb

File tree

5 files changed

+69
-51
lines changed

5 files changed

+69
-51
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<p align="center">
66
<em>A reactive Python notebook that's reproducible, git-friendly, and deployable as scripts or apps.</em>
7+
</p>
78

89
<p align="center">
910
<a href="https://docs.marimo.io" target="_blank"><strong>Docs</strong></a> ·
@@ -14,7 +15,8 @@
1415
</p>
1516

1617
<p align="center">
17-
<b>English | </b>
18+
<b>English</b>
19+
<b> | </b>
1820
<a href="https://github.com/marimo-team/marimo/blob/main/README_Traditional_Chinese.md" target="_blank"><b>繁體中文</b></a>
1921
<b> | </b>
2022
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>简体中文</b></a>
@@ -25,12 +27,12 @@
2527
</p>
2628

2729
<p align="center">
28-
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
29-
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
30-
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord" /></a>
31-
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
32-
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo" />
33-
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo" /></a>
30+
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
31+
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
32+
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord"/></a>
33+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
34+
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo"/>
35+
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo"/></a>
3436
</p>
3537

3638
**marimo** is a reactive Python notebook: run a cell or interact with a UI

README_Chinese.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,35 @@
44

55
<p align="center">
66
<em>这是一款响应式的Python笔记本,具有优秀的可复现性,原生支持Git,并可作为脚本或应用程序部署。</em>
7+
</p>
78

89
<p align="center">
910
<a href="https://docs.marimo.io" target="_blank"><strong>用户手册</strong></a> ·
1011
<a href="https://marimo.io/discord?ref=readme" target="_blank"><strong>Discord 社区</strong></a> ·
11-
<a href="https://github.com/marimo-team/marimo/tree/main/examples" target="_blank"><strong>示例</strong></a> ·
12+
<a href="https://docs.marimo.io/examples/" target="_blank"><strong>示例</strong></a> ·
1213
<a href="https://marimo.io/gallery/" target="_blank"><strong>展示廊</strong></a> ·
1314
<a href="https://www.youtube.com/@marimo-team/" target="_blank"><strong>YouTube</strong></a>
1415
</p>
1516

1617
<p align="center">
17-
<a href= "https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
18-
<b> | 简体中文 | </b>
18+
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
19+
<b> | </b>
20+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Traditional_Chinese.md" target="_blank"><b>繁體中文</b></a>
21+
<b> | </b>
22+
<b>简体中文</b>
23+
<b> | </b>
1924
<a href="https://github.com/marimo-team/marimo/blob/main/README_Japanese.md" target="_blank"><b>日本語</b></a>
2025
<b> | </b>
2126
<a href="https://github.com/marimo-team/marimo/blob/main/README_Spanish.md" target="_blank"><b>Español</b></a>
2227
</p>
2328

2429
<p align="center">
25-
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
26-
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
27-
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord" /></a>
28-
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
29-
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo" />
30-
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo" /></a>
30+
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
31+
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
32+
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord"/></a>
33+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
34+
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo"/>
35+
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo"/></a>
3136
</p>
3237

3338
**Marimo** 是一款响应式 Python 笔记本:运行单元格可与 UI 元素交互,marimo 会自动更新依赖于它的单元格(或将其<a href="#expensive-notebooks">标记为过时单元格</a>),从而保持代码和输出的一致性。**marimo** 笔记本以纯 Python 格式存储,可作为脚本执行,也可作为应用程序部署。

README_Japanese.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<p align="center">
66
<em>再現性が高く、Git対応で、スクリプトやアプリとして展開できるリアクティブなPythonノートブック。</em>
7+
</p>
78

89
<p align="center">
910
<a href="https://docs.marimo.io" target="_blank"><strong>ドキュメント</strong></a> ·
@@ -16,6 +17,8 @@
1617
<p align="center">
1718
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
1819
<b> | </b>
20+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Traditional_Chinese.md" target="_blank"><b>繁體中文</b></a>
21+
<b> | </b>
1922
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>简体中文</b></a>
2023
<b> | </b>
2124
<b>日本語</b>
@@ -24,12 +27,12 @@
2427
</p>
2528

2629
<p align="center">
27-
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
28-
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
29-
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord" /></a>
30-
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
31-
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo" />
32-
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo" /></a>
30+
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
31+
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
32+
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord"/></a>
33+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
34+
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo"/>
35+
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo"/></a>
3336
</p>
3437

3538
**marimo**はリアクティブなPythonノートブックです:セルを実行したりUI要素を操作すると、marimoは自動的に依存するセルを実行(または<a href="#expensive-notebooks">それらを古いものとしてマーク</a>)し、コードと出力の一貫性を保ちます。marimoノートブックは純粋なPythonとして保存され、スクリプトとして実行でき、アプリとして展開できます。

README_Spanish.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,35 @@
44

55
<p align="center">
66
<em>Un cuaderno (notebook) de Python reactivo que es reproducible, compatible con Git y desplegable como scripts o aplicaciones.</em>
7+
</p>
78

89
<p align="center">
910
<a href="https://docs.marimo.io" target="_blank"><strong>Documentos</strong></a> ·
1011
<a href="https://marimo.io/discord?ref=readme" target="_blank"><strong>Discord</strong></a> ·
11-
<a href="https://github.com/marimo-team/marimo/tree/main/examples" target="_blank"><strong>Ejemplos</strong></a> ·
12+
<a href="https://docs.marimo.io/examples/" target="_blank"><strong>Ejemplos</strong></a> ·
13+
<a href="https://marimo.io/gallery/" target="_blank"><strong>Galería</strong></a> ·
1214
<a href="https://www.youtube.com/@marimo-team/" target="_blank"><strong>YouTube</strong></a>
1315
</p>
1416

1517
<p align="center">
16-
<b>Español | </b>
17-
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>Inglés</b></a>
18+
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
19+
<b> | </b>
20+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Traditional_Chinese.md" target="_blank"><b>繁體中文</b></a>
21+
<b> | </b>
22+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>简体中文</b></a>
1823
<b> | </b>
19-
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>Chino</b></a>
24+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Japanese.md" target="_blank"><b>日本語</b></a>
2025
<b> | </b>
21-
<a href="https://github.com/marimo-team/marimo/blob/main/README_Japanese.md" target="_blank"><b>Japonés</b></a>
26+
<b>Español</b>
2227
</p>
2328

2429
<p align="center">
25-
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi" /></a>
26-
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
27-
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord" /></a>
28-
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
29-
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo" />
30-
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo" /></a>
30+
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
31+
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
32+
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord"/></a>
33+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
34+
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo"/>
35+
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo"/></a>
3136
</p>
3237

3338
**marimo** es un cuaderno (notebook) de Python: ejecuta una celda o interactúa con un elemento de la interfaz de usuario y marimo ejecuta automáticamente las celdas dependientes (o <a href="#expensive-notebooks">las marca como desactualizadas</a>), manteniendo el código y los resultados consistentes. Los cuadernos (notebooks) de marimo se almacenan como código Python puro, ejecutables como scripts y desplegables como aplicaciones.

README_Traditional_Chinese.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,35 @@
44

55
<p align="center">
66
<em>一個響應式的 Python 筆記本,可重現、支援 Git 版本控制,並可部署為腳本或應用程式。</em>
7+
</p>
78

89
<p align="center">
9-
<a href="https://docs.marimo.io" target="_blank"><strong>文件</strong></a> ·
10-
<a href="https://marimo.io/discord?ref=readme" target="_blank"><strong>Discord</strong></a> ·
11-
<a href="https://docs.marimo.io/examples/" target="_blank"><strong>範例</strong></a> ·
12-
<a href="https://marimo.io/gallery/" target="_blank"><strong>展示廊</strong></a> ·
13-
<a href="https://www.youtube.com/@marimo-team/" target="_blank"><strong>YouTube</strong></a>
10+
<a href="https://docs.marimo.io" target="_blank"><strong>文件</strong></a> ·
11+
<a href="https://marimo.io/discord?ref=readme" target="_blank"><strong>Discord</strong></a> ·
12+
<a href="https://docs.marimo.io/examples/" target="_blank"><strong>範例</strong></a> ·
13+
<a href="https://marimo.io/gallery/" target="_blank"><strong>展示廊</strong></a> ·
14+
<a href="https://www.youtube.com/@marimo-team/" target="_blank"><strong>YouTube</strong></a>
1415
</p>
1516

1617
<p align="center">
17-
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
18-
<b> | 繁體中文 | </b>
19-
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>简体中文</b></a>
20-
<b> | </b>
21-
<a href="https://github.com/marimo-team/marimo/blob/main/README_Japanese.md" target="_blank"><b>日本語</b></a>
22-
<b> | </b>
23-
<a href="https://github.com/marimo-team/marimo/blob/main/README_Spanish.md" target="_blank"><b>Español</b></a>
18+
<a href="https://github.com/marimo-team/marimo/blob/main/README.md" target="_blank"><b>English</b></a>
19+
<b> | </b>
20+
<b>繁體中文</b>
21+
<b> | </b>
22+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Chinese.md" target="_blank"><b>简体中文</b></a>
23+
<b> | </b>
24+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Japanese.md" target="_blank"><b>日本語</b></a>
25+
<b> | </b>
26+
<a href="https://github.com/marimo-team/marimo/blob/main/README_Spanish.md" target="_blank"><b>Español</b></a>
2427
</p>
2528

2629
<p align="center">
27-
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
28-
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
29-
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord" /></a>
30-
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
31-
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo" />
32-
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo" /></a>
30+
<a href="https://pypi.org/project/marimo/"><img src="https://img.shields.io/pypi/v/marimo?color=%2334D058&label=pypi"/></a>
31+
<a href="https://anaconda.org/conda-forge/marimo"><img src="https://img.shields.io/conda/vn/conda-forge/marimo.svg"/></a>
32+
<a href="https://marimo.io/discord?ref=readme"><img src="https://shields.io/discord/1059888774789730424" alt="discord"/></a>
33+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/marimo?label=pypi%20%7C%20downloads"/>
34+
<img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/marimo"/>
35+
<a href="https://github.com/marimo-team/marimo/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/marimo"/></a>
3336
</p>
3437

3538
**marimo** 是一個響應式的 Python 筆記本:執行單元格或與 UI 元素互動時,marimo 會自動執行相依的單元格(或<a href="#expensive-notebooks">將其標記為過時</a>),保持程式碼和輸出的一致性。marimo 筆記本以純 Python 格式儲存(具有一流的 SQL 支援),可作為腳本執行,並可部署為應用程式。

0 commit comments

Comments
 (0)