El nacimiento del manual chino Deno: 18 voluntarios completaron todas las API principales de Deno en 5 días

Desde que ry anunció el lanzamiento de la primera versión oficial de Deno 1.0 el 13 de mayo de 2020, el segundo aniversario de Deno, Deno ha vuelto a atraer la atención de los desarrolladores.

La semana pasada, también organicé algunos voluntarios que están interesados ​​en Deno, en un esfuerzo por contribuir a la ecología de Deno. Lo primero es traducir el manual de la API en chino.

Después de los esfuerzos de los voluntarios, el 80% de los documentos se tradujeron en 3 días, la última versión en ese momento era Deno v0.40. De acuerdo con la práctica habitual, Deno lanzará una versión pequeña todos los viernes.Finalmente iniciamos la actualización de Deno, y el tema de cómo mantener la actualización sincrónica de los documentos en chino e inglés también está ante nosotros.

Primero creé el proyecto deno_api_diff y mantuve .d.ts los cambios entre versiones a través de la función de vista de diferencias que viene con GitHub  :

Pero este método todavía tiene un gran problema, se puede ver en las estadísticas de la última columna que cada vez que se actualiza la versión de Deno, los .d.ts cambios de archivo son tan pocos como unos pocos cientos de líneas y hasta miles de líneas.

Al final, después de una discusión en la comunidad, decidimos mantener el texto original en inglés y hacer la traducción al chino personalizando la etiqueta. Al modificar el tema predeterminado de typedoc, también se puede realizar la función de contraste chino-inglés.

Así que desarrollé el tema typedoc-deno-theme para mostrar comparaciones en chino e inglés línea por línea. Además, typedoc-plugin-deno fue desarrollado para analizar etiquetas personalizadas. Etiqueta personalizada que utilizamos @i18nson: @param_i18n,, @return_i18ny así sucesivamente.

Como era la primera vez que escribía complementos y temas de typedoc, y la documentación y los artículos de typedoc eran demasiado escasos, leí miles de líneas de código en el directorio src / lib / converter y finalmente completé el análisis y la visualización de estas etiquetas personalizadas. . El efecto es el siguiente:

Actualmente, typedoc-plugin-deno es un complemento, pero typedoc-deno-theme es un tema desarrollado específicamente para documentos en chino Deno. En el futuro, desarrollaré un complemento y un tema más general que admita la comparación bilingüe, que se puede utilizar para cualquier documento bilingüe basado en typedoc.

Se está acercando cada vez más a la primera versión oficial de Deno. Refactorizaré completamente la extensión vscode-deno este feriado del Primero de Mayo. Si está familiarizado con el desarrollo de extensiones vscode, o desea participar, puede desarrollar esta extensión conmigo.

Si está interesado en Deno, puede hacer clic para leer el texto original y seguir la columna [Comunidad de desarrolladores de Deno].

Supongo que te gusta

Origin blog.csdn.net/vCa54Lu0KV27w8ZZBd/article/details/105721009
Recomendado
Clasificación