{"id":21889301,"url":"https://github.com/sorashu/hitsz-lab-report-template","last_synced_at":"2025-03-22T02:40:55.017Z","repository":{"id":181432606,"uuid":"654183304","full_name":"SoraShu/HITsz-Lab-report-Template","owner":"SoraShu","description":"A Typst template for Lab-report in HITsz","archived":false,"fork":false,"pushed_at":"2024-05-01T05:04:27.000Z","size":267,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-26T20:46:40.129Z","etag":null,"topics":["hitsz","typst","typst-template"],"latest_commit_sha":null,"homepage":"","language":"Typst","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SoraShu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-15T14:58:40.000Z","updated_at":"2024-05-01T05:04:31.000Z","dependencies_parsed_at":"2024-11-28T11:26:43.758Z","dependency_job_id":"59157817-e713-493d-be79-a55c4f69c553","html_url":"https://github.com/SoraShu/HITsz-Lab-report-Template","commit_stats":null,"previous_names":["sorashu/hitsz-lab-report-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoraShu%2FHITsz-Lab-report-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoraShu%2FHITsz-Lab-report-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoraShu%2FHITsz-Lab-report-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoraShu%2FHITsz-Lab-report-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SoraShu","download_url":"https://codeload.github.com/SoraShu/HITsz-Lab-report-Template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244898407,"owners_count":20528335,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hitsz","typst","typst-template"],"created_at":"2024-11-28T11:23:40.768Z","updated_at":"2025-03-22T02:40:55.000Z","avatar_url":"https://github.com/SoraShu.png","language":"Typst","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HITsz Lab-report Template\n\n用于 HITsz 实验报告的 Typst 模版，轻量、低配置。\n\n## 目的\n\n此模版目标在于解决以下问题：\n\n- 实验报告只能使用可以编辑 docx/doc 格式文件的富文本编辑器。这类编辑器大多存在兼容性问题，不一定在各个系统上运作良好，给使用某些操作系统的用户带来了困扰。\n- 实验报告模版由 [MS Word](https://www.microsoft.com/en-ww/microsoft-365/word) 制作，在其它编辑器上可能出现排版错位。~~且 MS Word 需要付费购买，购买此软件可能给经济困难的同学带来经济压力。~~\n- 实验老师对于是否使用模版态度比较模糊，但如果使用无格式的 plaintext 或者通过 markdown 等标记语言不加排版地生成 PDF 实验报告，实验老师可能不接受，而且给实验批改带来障碍。\n\n因此本模版致力于提供一个开源跨平台的编写实验报告的方案，且此方案生成接近实验报告模版的产物。\n\n## Why Typst\n\n下面列出使用 Typst 之前我尝试过的工具，以及我为什么最终放弃使用。\n\n- Markdown: 热门的标记语言。他的主要问题在于他只是一个等价于 HTML 的标记语言（甚至比 HTML 更弱，使用时时常需要嵌入 HTML），并不能很方便地支持复杂排版，且对于某些格式需要如何实现我毫无头绪，如页脚和页眉。\n- Latex: 著名的排版系统。我在编写 Latex 模版上缺乏经验，整理出来的模版效果不佳。且 Latex 整套工具链较重。\n\nTypst 可以说是介于以上两者之间。用它来编写文档上手很快，但它同时是一个较为完整的排版系统。同时 Typst 是一个轻量级的工具，本身配置也较为简单，0 配置下的效果就相当不错。\n\n## 如何使用\n\n安装 Typst 的 cli 工具，具体安装参考 [typst#installation](https://github.com/typst/typst#installation)。\n\nclone 本项目，将本项目安装为本地包\n\n```bash\n./install.sh\n```\n\n该脚本默认会将包安装到 `${XDG_DATA_DIR}/typst/packages/${TYPST_LOCAL_NAMESPACE}/hitsz-lab-report-template/${VERSION}`。可以通过 export 对应环境变量的形式自定义该路径。\n\n随后可以使用 Typst 自带的模版初始化功能在对应目录下初始化您的项目:\n\n```bash\n# 若您使用了自定义的环境变量, 请自行修改下面的命令\ntypst init @local/hitsz-lab-report-template:1.0.0 ${PROJECT_NAME}\n```\n\n## 说明\n\n没有看过其它专业的实验报告模版，不确定是否可用于非计算机科学与技术学院的实验报告。\n\n目前模版排版和实验报告的模版并不是 1:1 复刻，鉴于实验报告模版格式也不尽相同，本模版也无力 cover 实验报告的所有格式变体。\n\n对于实验报告能否用本模版编写，以及本模版的产物能否作为实验报告提交，最终解释权在于接收实验报告的老师或助教，本项目不做任何保证。\n\n## TODO\n\n- [ ] 支持自定义各级标题的序号格式。\n- [ ] 支持代码块显示行号。（等待 Typst 支持此特性）\n- [ ] 线上编辑。（需要将字体同时上传）\n\n## 参考\n\n本模版几乎是从 [github:werifu/HUST-typst-template](https://github.com/werifu/HUST-typst-template) 修改而成，在此特别感谢。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsorashu%2Fhitsz-lab-report-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsorashu%2Fhitsz-lab-report-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsorashu%2Fhitsz-lab-report-template/lists"}