<div align="center">

WebLatex

<a href="https://www.producthunt.com/posts/weblatex?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-weblatex" target="_blank" rel="noreferrer noopener"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=383518&theme=dark" alt="WebLaTeX - 一个集成了Git、VSCode、Copilot、Grammarly等功能的LaTeX编辑器 | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

一个完整的Overleaf替代品，集成了VSCode + 网页 + Git + GitHub Copilot + Grammarly/LanguageTool + 实时协作支持

<a href="https://github.com/sanjib-sen/weblatex/generate" target="_blank" rel="noreferrer noopener"> </a>

</div>

我很高兴地分享，这个项目已经得到全球认可，许多人正在使用这个工具来创建他们的期刊、研究论文和个人简历。来自明尼苏达大学、科罗拉多大学、犹他大学、康奈尔大学，甚至麻省理工学院等离子科学和聚变中心的学生、讲师和教授都在使用这个工具来创建文档。你们中的一些人亲自感谢我这个项目，并希望将来能够贡献，这实在是出乎我的意料！再次感谢你们无限的支持！

• WebLatex
  • 预览
  • 为什么选择WebLatex
    • 为什么不直接使用Overleaf
  • 新功能
  • 安装说明
  • 我的PDF在哪里？
  • 编辑器使用说明
  • 使用LuaLatex或其他Tex程序
  • GitHub Copilot
  • Grammarly
  • LanguageTools
  • 实时协作
  • PDF查看器暗黑模式
  • 配置
  • 更多功能和配置
  • 贡献
  • 致谢
  • 未来计划
  • 联系方式

预览

视频预览

星标历史

<a href="https://star-history.com/#sanjib-sen/weblatex&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=sanjib-sen/weblatex&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=sanjib-sen/weblatex&type=Date" /> <img alt="星标历史图表" src="https://api.star-history.com/svg?repos=sanjib-sen/weblatex&type=Date" /> </picture> </a>

为什么选择WebLatex

你是否使用LaTeX作为简历生成器/研究项目/文档/文章或任何文档？那么你可能有时会想，如果能够利用git的优势该多好。你可以随时提交更改并回滚到旧版本。当写一篇期刊时，你突然想起需要之前删除的部分。你会怎么做？

你是否想过，如果能够使用你最喜欢的编辑器VSCode来编写文档该多好？拥有所有你配置的设置、喜欢的主题和可能比你那个令人讨厌的女朋友更受欢迎的扩展？

想象一下，你的论文导师和副导师想对你的文档进行一些修改。你会怎么做？给他们发邮件附上文档，然后让他们回复更新后的版本？这已经不是80年代了。

或者，你在车里，离开了笔记本电脑/台式机。突然想起忘记把文档的标题从"Lorem Ipsum"改成实际的文档标题。如果能够随时随地用手机修改文档不是很棒吗？或者用更极客的方式，用Apple Watch？

如果你可以在每次保存后自动格式化你的LaTeX代码，那会怎样？

最重要的是，如果你可以使用GitHub Copilot自动完成你的LaTeX命令和句子呢？忘记了某个命令？别担心，这个工具会猜测下一个可能的命令并在每一步向你建议。它不仅可以完成和建议命令，还可以完成整个句子和段落！你能想象使用这个工具你会变得多么强大吗？

我还需要告诉你Grammarly内置语法和拼写检查器的有用性吗？或者LanguageTool？如果你更喜欢开源的话？

是的！现在你可以通过Git、GitHub、完整的VSCode集成、Grammarly、实时协作和Web支持来实现所有这些功能 - WebLatex。

为什么不直接使用Overleaf

是的，但是

• 在Overleaf中，你必须支付40美元才能获得git功能，而且这甚至不是最好或完整的git体验。
• 支付40美元才能与超过1人协作
• 没有VSCode、代码格式化、Grammarly或暗黑模式/自定义
• GitHub Copilot：比Clippy好得多！

新功能

• GitHub Copilot
• 增加了对最新texlive-full包的支持。现在，你可以不用再担心包的支持问题。

安装说明

<a href="https://github.com/sanjib-sen/weblatex/generate" target="_blank"> </a>

你可以选择复刻这个仓库或者直接使用它作为模板。如果你将其用作模板，你将无法获得最新更新。而且你只能复刻一次。所以，我建议将其用作模板，并手动检查更新。

1. 登录或注册GitHub

2. 使用此仓库作为模板或复刻。

   • 使用作为模板（推荐）： 只需点击Use this template和Create a new Repository或直接点击这里

   或者，

   • 复刻： 复刻这个仓库或直接点击这里

3. 给它一个名称并选择Create Fork / Create repository from template

4. 选择 <> Code > CodeSpaces > Create Codespace on Main

5. 它将开始安装。第一次你需要等待2分钟。之后只需2/3秒就能打开

我的PDF在哪里？

生成的PDF将保存在**/PDF**目录中

编辑器使用说明

1. 按Ctrl+S将保存文档并在PDF文件夹中生成PDF
2. 要查看生成的PDF，点击PDF文件。但是第一次打开预览需要20/30秒。所以不要慌。之后，它将立即生成和预览PDF
3. 每次编辑时，你的代码将自动保存，PDF也会自动生成
4. 你可以在Terminal > Output > Latex Compiler以及Latex Workshop侧边栏中查看所有错误日志
5. 如果显示Error showing PDF或遇到任何不便，只需重新加载浏览器或按Ctrl+R
6. 像使用Visual Studio Code一样使用它
7. 不要删除devcontainer.json文件。但你可以编辑那里的属性来自定义很多东西！

使用LuaLatex或其他Tex程序

在你的主.tex文件中添加这行

%!TEX program = <tex_program>

例如，要使用**LuaLatex**：

%!TEX program = lualatex

GitHub Copilot

好消息，各位！GitHub Copilot已经集成到这个工具中了，感谢@thodson-hugs。这个程序将根据你的文档和之前的写作内容，建议下一个命令、句子和段落。

要关闭这个功能，只需在./.devcontainer/devcontainer.json文件的扩展列表中删除或注释掉"GitHub.copilot"扩展。

 "extensions": [
      "...",
      //"GitHub.copilot",
      "..."
      ]

Grammarly

这个编辑器为.tex文件内置了Grammarly支持。

要禁用Grammarly，你可以在./.devcontainer/devcontainer.json文件的扩展列表中删除或注释掉"ms-vsliveshare.vsliveshare"扩展。

 "extensions": [
      "...",
      //"znck.grammarly",
      "..."
      ]

如果你想在其他文件中使用Grammarly，前往./.devcontainer/devcontainer.json并在以下位置添加你的文件扩展名

  "grammarly.files.include": ["*.md", ".YourFileExtension"]

如果你不想在其他文件中使用Grammarly，在以下位置添加你的文件扩展名

  "grammarly.files.exclude": ["*.md", ".YourFileExtension"]

你可以在.tex文件以外的任何文件中使用Grammarly。只需按CTRL + SHIFT + P并搜索Grammarly: Check text。 此编辑器使用Grammarly免费账户来检查语法和拼写。但如果你想使用Grammarly高级账户，只需按下CTRL + SHIFT + P并搜索Grammarly: 登录/连接你的账户。

LanguageTools

此编辑器内置了对BibTEX、ConTEXt、LATEX、Markdown、Org、reStructuredText、R Sweave和XHTML文档的LanguageTool支持，但默认情况下为了支持Grammarly而禁用。如果你想使用LanguageTool而非Grammarly，只需取消注释.devcontainer/devcontainer.json`中的以下行：

"extensions": [
    "...",
    "valentjn.vscode-ltex",
    "..."
  ]

并从./.devcontainer/devcontainer.json文件的扩展列表中删除或注释掉"znck.grammarly"扩展。（推荐）

"extensions": [
    "...",
    // "znck.grammarly",
    "..."
  ]

实时协作

关于实时协作的所有信息：点击这里

只需点击Live Share侧边栏按钮，你就可以开始了

如果你完全不需要实时协作功能，你可以从./.devcontainer/devcontainer.json文件的扩展列表中删除或注释掉"ms-vsliveshare.vsliveshare"扩展。

"extensions": [
    "...",
    // "ms-vsliveshare.vsliveshare",
    "..."
  ]

PDF查看器暗黑模式

如果你的操作系统处于暗黑模式，PDF查看器默认会以暗黑模式预览PDF。要在系统范围的暗黑模式下以正常模式查看PDF，只需删除或注释./.devcontainer/devcontainer.json中的这些行。

  //"latex-workshop.view.pdf.color.dark.pageColorsBackground":"#171717",
  //"latex-workshop.view.pdf.color.dark.pageColorsForeground":"#FFFFFF",
  //"latex-workshop.view.pdf.color.dark.backgroundColor":"#171717",

配置

• 要更改输出目录，请修改./.devcontainer/devcontainer.json中的以下属性：

  "latex-workshop.latex.outDir": "<你的目录名>",
  "latex-workshop.latex.magic.args": ["-output-directory=<你的目录名>"],

• 其他配置（如PDF生成延迟、自动保存等）可以在./.devcontainer/devcontainer.json中修改。查看Wiki

更多功能和配置

还有很多功能，如：

• 智能提示（引用、参考）
• 代码片段和快捷键
• 代码检查
• 格式化
• 代码折叠

以及更多。

所有功能和配置都可以在这里找到。

贡献

我欢迎并请求你为这个项目做出贡献。你可以创建一个新的问题来让我知道你的担忧/请求，或者直接发送一个带有你期望更改的拉取请求。

致谢

• @James-Yu的latex-workshop提供所有Latex支持。
• danteev/texlive用于Latex编译。
• @znck的Grammarly提供Grammarly支持。
• @thodson-hugs提供GitHub Copilot支持。

下一步计划

1. 优化后端以减少安装时间和首次显示PDF的时间
2. 文档编写
3. 发布：将PDF导出为发布版本
4. 听取你的建议

联系方式

1. 发送邮件至mail@sanjibsen.com
2. Facebook, LinkedIn