/leaflet_zh

Leaflet 中文网

Primary LanguageHTMLApache License 2.0Apache-2.0

Leaflet - 中文文档

Leaflet 是一个开源并且对移动端友好的交互式地图 JavaScript 库。本项目目的在于为使用 Leaflet 的中文用户提供一份内容完善、准确度相对较高并且更新及时的中文文档,希望能够给大家在学习或开发过程中带来一定的便利。

Leaflet 中文站点:https://leafletjs.cn/

Leaflet 官方站点:https://leafletjs.com/

📢 公告:Leaflet 1.9.4 版本官方文档已同步到中文站点,并完成了翻译和校正!如果大家在使用过程中发现了文档中的错误或者不足之处,欢迎大家提出 issue 或者 PR,我们会在尽快对其进行处理。

翻译进度(v1.9.4)

  • 概况
  • 教程
    • 列表页(已完成)
    • Leaflet 快速入门指南(已完成)
    • 在移动端使用 Leaflet(已完成)
    • 使用带有自定义图标的标记(Marker)(已完成)
    • 无障碍地图(已完成)
    • 在 Leaflet 中使用 GeoJSON(已完成)
    • 互动式 choropleth 地图(已完成)
    • Layer Groups 和 Layers Control(已完成)
    • Zoom levels 缩放比例(已完成)
    • Non-geographical maps(已完成)
    • WMS and TMS(已完成)
    • Working with map panes(已完成)
    • Overlays: Image, Video, SVG
    • 扩展 Leaflet: Class Theory(已完成)
    • 扩展 Leaflet: Layers(已完成)
    • 扩展 Leaflet: Handlers and Controls (已完成)
  • 文档
    • 地图(已完成)
    • 地图方法(已完成)
    • 地图杂项(已完成)
    • UI 图层(已完成)
    • 栅格图层(已完成)
    • 矢量图层(已完成)
    • 其它图层(已完成)
    • 基本类型(已完成)
    • 控件(已完成)
    • Util常用方法类(已完成)
    • Dom常用方法类(已完成)
    • 基础类(已完成)
    • 其它(已完成)
  • 下载
  • 插件
    • Tile & Image 图层(已完成)
    • Overlay data(已完成)
    • Overlay Display(已完成)
    • Overlay interaction(已完成)
    • 地图交互(已完成)
    • 各种各样的(已完成)
    • 综合的(已完成)
    • 开发属于自己的插件(已完成)
  • 博客

加入翻译

由于本人精力有限,希望更多的小伙伴可以加入我们,一起参与翻译,共同来帮助更多人。如果你完全没接触过翻译工作也不用担心,我们将会为你准备完善的翻译规范和操作说明。

开始翻译前,你可以先加入我们的交流群,然后在群里通过以下方式认领,确保没有重复工作。

认领制度

对于未被翻译的章节,你应该在翻译之前进行翻译认领来保证没有人和你重复工作。 很简单,请从 repo 的 issue 列表中认领,如果没有对应章节的 issue,自己创建一个即可。 认领成功后就代表你已经成功占到一个坑,你可以开始慢慢翻译自己的文章了。 如果占坑太久你的占位可能被取消,尽量在两周内完成。

对于已经翻译的章节,欢迎做校验工作,校验不需要认领,fork 后修改并发 Pull Request 即可。

翻译流程

1、fork 要翻译的 repo

2、如果是新翻译章节,应参照对应的原文进行翻译;如果是校对则直接修改

建议使用 Sublime Text、Vscode 等支持 Markdown 类编辑器编辑,同时开启横向双列模式。

3、安装 jekyll, 翻译时启动 watch 来实时看结果(jekyll官方安装文档, 强烈推荐在 ubuntu 环境下安装 jekyll

jekyll serve

打开:127.0.0.1:4000

4、翻译结束,提交 Pull Request

5、fork 后的 repo 如何同步本 repo?

// 添加 upstream 源,只需执行一次
git remote add upstream https://github.com/NICEXAI/leaflet_zh.git
// 拉取远程代码
git pull upstream master
// 更新 fork 仓库
git push origin master

更多参考:https://help.github.com/articles/syncing-a-fork/

其它事项

C:\User>gem install jekyll
Temporarily enhancing PATH for MSYS/MINGW...
Building native extensions. This could take a while...
ERROR:  Error installing jekyll:
    ERROR: Failed to build gem native extension.

    current directory: C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/http_parser.rb-0.6.0/ext/ruby_http_parser
C:/Ruby25-x64/bin/ruby.exe -r ./siteconf20180308-3672-ueo7ea.rb extconf.rb
creating Makefile

current directory: C:/Ruby25-x64/lib/ruby/gems/2.5.0/gems/http_parser.rb-0.6.0/ext/ruby_http_parser
 make "DESTDIR=" clean

如果安装 jekyll 过程中遇到上面问题或者安装 msys2 过程中报错,可以参考以下文章进行解决:

参与翻译人员名单

定期更新,谢谢各位辛勤贡献

特殊贡献者人员名单

  • 寒江孤影
  • 三月

捐赠中文社区

其它方面的支持与赞助

  • 特别感谢 Robeeask 社区 对 Leaflet 中文网的部分资金赞助
  • 特别感谢 JetBrains 为本开源项目提供免费的 License 授权

只要文档符合 翻译规范,欢迎你来一起完善