Giter VIP home page Giter VIP logo

bithesis-wiki's Introduction

欢迎

BIThesis 是针对北京理工大学本科生毕业毕业论文、研究生学位论文的一个非官方的 LaTeX 模板,BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 LaTeX 模板。

本项目为 BIThesis 在线文档 的代码仓库。如果你仅仅想使用 BIThesis,请访问 BIThesis仓库。

Note

本项目获得了北京理工大学研究生院北京理工大学教务部北京理工大学计算机学院 的认可、背书与大力支持。详见:致谢 - 官方赞助

交流社区

订阅更新,询问问题,提出需求……请加入北理 BIThesis 官方社区!

Join on QQ Chat Group

本地编译运行

克隆仓库

git clone https://github.com/BITNP/BIThesis-wiki

cd BIThesis-wiki

安装依赖

pnpm install

编译运行

你可以构建出所有文件(在 wiki/.vitepress/dist/ 下):

pnpm build

或者实时预览:

pnpm dev

贡献者指南

详情请查看贡献者指南

贡献者

本项目的存在离不开以下所有贡献者的辛勤贡献。参见Github ContributorsBIThesis - 致谢

发布状态

CI Build status
Vercel Deploy Vercel Status

📖 BIThesis ©BITNP. Released under the LaTeX Project Public License.

Maintained with help from contributors.

bithesis-wiki's People

Contributors

czleader avatar dependabot[bot] avatar felinae98 avatar fky2015 avatar guguguxiao avatar lancern avatar mwl0811 avatar phy25 avatar renovate[bot] avatar shoopshoop avatar silverster98 avatar spencerwooo avatar ydx-2147483647 avatar zijin-evan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

bithesis-wiki's Issues

[Bug]: 本科生毕业设计的overleaf链接挂了

发生了什么?

点击链接报错:Sorry, we can’t find the page you are looking for.

你期望的结果

No response

问题复现的步骤

  1. 进入页面
  2. 点击overleaf的链接

最小可复现用例或者截图

No response

操作系统或平台

No response

LaTeX 发行版以及发行年份

No response

BIThesis 模板

No response

日志信息

No response

【讨论】是否需要从 Vercel 迁移 wiki 到 Cloudflares

目前 Vercel 有两个问题:

  1. 绑定在我个人的账号下,未来我可能没有充足的时间维护。
  2. Vercel 的生产模式需要手动去升级,没法绑定仓库里的最新 commit。

不过 Cloudflares 在大陆访问的速度可能有点难以保证?

SEO 优化

<!-- HTML Meta Tags -->
  <title>BIThesis</title>
  <meta name="description" content="📖 Unofficial LaTeX templates for your bachelor graduation thesis (and more) here at BIT.">

  <!-- Facebook Meta Tags -->
  <meta property="og:url" content="https://bithesis.bitnp.net">
  <meta property="og:type" content="website">
  <meta property="og:title" content="BIThesis">
  <meta property="og:description" content="📖 Unofficial LaTeX templates for your bachelor graduation thesis (and more) here at BIT.">
  <meta property="og:image" content="">

  <!-- Twitter Meta Tags -->
  <meta name="twitter:card" content="summary_large_image">
  <meta property="twitter:domain" content="bithesis.bitnp.net">
  <meta property="twitter:url" content="https://bithesis.bitnp.net">
  <meta name="twitter:title" content="BIThesis">
  <meta name="twitter:description" content="📖 Unofficial LaTeX templates for your bachelor graduation thesis (and more) here at BIT.">
  <meta name="twitter:image" content="">

  <!-- Meta Tags Generated via https://www.opengraph.xyz -->

目前的 SEO 惨不忍睹。

[Suggestion] 改进Wiki中使用VSCode编译模板的部分

下载VSCode的latex-workshop插件后,其中latex-workshop.latex.tools自带latexmk的选项,但是其参数指定与Wiki上推荐的方法有出入,按插件默认的参数编译后会直接报错,无法正常编译。

建议在Wiki中的相应部分加入强调,检查使用latex-workshop时相关的recipe/tools参数是否与Wiki上一致,以免浪费时间。

Revise the warning regarding v2

目前,bithesis.cls 已经模板文件一起分发,不再需要用户从包管理器手动安装。
因此,有必要删除/修正相关的提示,以降低引起歧义的可能。

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/test.yml
  • actions/checkout v4
  • actions/setup-node v4
  • gaurav-nelson/github-action-markdown-link-check v1
npm
package.json
  • @types/node ^20.0.0
  • @typescript-eslint/eslint-plugin ^7.0.0
  • @typescript-eslint/parser ^7.0.0
  • eslint ^9.0.0
  • eslint-config-prettier ^9.0.0
  • eslint-config-xo ^0.45.0
  • eslint-plugin-vue ^9.15.1
  • markdown-it-footnote ^4.0.0
  • prettier ^3.0.0
  • typescript ^5.1.3
  • vitepress 1.2.3
  • vue ^3.3.4

  • Check this box to trigger a request for Renovate to run again on this repository

在“如何开始”中添加MiKTeX安装相关内容

目前,wiki中在“如何开始”中为Windows 和 Linux 系统系统的用户推荐使用TeX Live并提供了TeX Live的安装方式。但是,在实际使用中,TeX Live存在一定的问题如下:

  • TeX Live安装体积较大,达数GB
  • TeX Live按年份分发,在大版本之间没有流畅的原地升级路径。
  • TeX Live进行包升级时,有概率出现升级失败的情况,需要尝试多次运行升级命令(可能是因为安装的包太多或者跨版本太多导致的,存疑)
    其中,TeX Live按年份分发难以原地升级,可能导致用户无法正常更新bithesis,导致版本过低的问题。

而MiKTeX可以做到

  • MiKTeX默认安装体积小,安装快
  • MiKTeX安装后可以一直平滑升级
  • MiKTeX的控制台相对更好用

但是会有如下问题

  • MiKTeX默认安装的包较少,在第一次使用某个包时,若本地不存在则需要联网安装(可以配置为在编译时自动安装不存在的包)

因此可以考虑

  • (基础) 添加MiKTeX安装教程并写明其优劣
  • (进阶) 推荐安装MiKTeX而不是Texlive

其中对教程若进行“基础”更改应该不会导致兼容性问题,因为仍默认推荐用户使用TeX Live。而进行“进阶”修改,则可能会造成问题,例如

  • 目前项目CI使用TeX Live,而没有MiKTeX的相关测试流程
  • MiKTeX默认安装的包较TeX Live少很多,因此在使用时需要联网安装,可能会对用户造成困惑或问题
  • 使用MiKTeX时可能会和TeX Live出现潜在的不一致,如何确定并解决?

希望通过本issue与维护者和使用者讨论相关问题。

不应推荐在linux下使用系统包管理器安装texlive

使用系统包管理器(如apt)安装的texlive是由发行版重新打包的版本,因此对于使用非滚动发行的发行版的用户会安装到老版本的texlive,如ubuntu 22.04中为texlive 2021,ubuntu 20.04中为texlive 2019,而ubuntu 18.04中为texlive 2017。see https://tug.org/texlive/distro.html and https://tug.org/texlive/debian.html

同时,系统包管理器将texlive安装到系统目录中,也无法使用tlmgr更新。

关于“使用 VS Code 撰写与编译 LaTeX 模板”部分的一些修改建议

相关地址:https://bithesis.bitnp.net/guide/configure-and-compile.html#%E5%9C%A8-vs-code-%E4%B8%AD%E4%BD%BF%E7%94%A8-latexmk-%E7%BC%96%E8%AF%91

  • 问题描述:
    按照文档的提示,需要“在 VS Code 的设置中添加如下的内容定义”,按照我的理解,意味着要在如下的文件中
    ~/Library/Application Support/Code/User/settings.json(Mac)
    或者
    %appdata%\Roaming\Code\User\settings.json(Windows)
    添加文档中所述的内容。

    这样会导致LaTeX Workshop的默认设置被覆盖,并使得未来的LaTeX编译均使用XeTeX进行编译,可能会导致其他不兼容XeTeX的模板编译错误。

  • 可能的解决方法
    LaTeX Workshop自带了一些如"latexmk", "latexmk (latexmkrc)", "latexmk (lualatex)", "latexmk (xelatex)"等编译模板,其中"latexmk (xelatex)"与文档所述的编译命令类似,并且经测试可以完成对研究生毕设模板的编译。

  • 可能的文档或模板修改方法

  1. latex-workshop.latex.recipe.default命令中可以指定是选择“第一个”工具进行编译,还是选择“上一个”。因此文档中可以指明修改该项设置为“上一个”,随后点击边栏TeX图标中Build LaTeX project - Recipe: latexmk (xelatex)

  2. 按照扩展开发者的建议https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipes

If you want to preset a per-file recipe, you may also consider place the LaTeX Workshop-specific derivative %!LW recipe=recipe-name at the top of your root file, similar to the wider recognized %!TeX root=root-file magic comment.

是否可以在模板头部添加相关内容以默认选择XeTeX进行编译?

Optimize wiki structure.

目前的文档结构有一些问题:

  • 「下载与使用模板」中包含了 LaTeX 的学习资源,此部分内容可以单独成一个页面。
  • 「下载与使用模板」中缺少引导。
  • 「疑难杂症」的优先级可以提高(比如放在 toolbar 中)

补充转换 Word 的方法

https://github.com/BHOSC/BUAAthesis/blob/fea9ab7114b000dc1d2b5ce7573b2d65bbb67683/README.md?plain=1#L89-L104

可使用如下方法将 LaTeX 文件(或编译后的 pdf 格式文件)转换为 Word 文件。

注意:将未公开的论文上传至网络有风险,推荐在本地进行转换。

pandoc 本地转换

  • 具体操作可参考 Latex2Word 这篇博客。
  • 优点:公式支持相对较好;可以基于 Word 模板进行转换。
  • 缺点: subfigure 支持差(可手动对编译后的 pdf 文件截图,进行替换);需手动调整对公式的\ref(可使用 Word 全局替换)。

在线转换

如下网址效果较好:

  • ilovepdf:整体效果好,包括页眉和页脚;公式支持差。
  • nitro:需要注册;对超链接、目录、段落格式和字体等支持较好;公式支持差。

打开`settings.json`描述太模糊

“推销”时同学反映 VS Code 第一步就卡住了……

VS Code 的设置项目可以通过快捷键 `ctrl/cmd + ,` 打开 UI 设置界面,之后点击右上角 `Open Settings (JSON)` 按钮即可打开相应的 JSON 格式配置文件,我们在这里即可定义 LaTeX 编译工具。其中:

一步化作两步

快捷键 ctrl/cmd + , 打开 UI 设置界面

这里被误以为是两步,不知道怎么“打开 UI 设置界面”。

建议用“以”连接,或者改成“……(此时会打开 UI 设置界面)”。

找不到按钮

点击右上角 Open Settings (JSON) 按钮即可打开相应的 JSON 格式配置文件

VSC 有好几个“右上角”。在大屏幕上,它们还不挨着,导致同学只找了最下面的“右上角”,结果没找到。

右上角

另外,如果安装了语言包,这个按钮叫打开设置 (json),不过相信一般人能转的过来。

如果 VitePress 能做到,建议加图标(codicon go to file);也可改成搜索latex-workshop.latex.tools,然后单击“在settings.json中编辑”。

搜索

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.