1 Star 7 Fork 1

边城 / typora-extension

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

Typora Extention

一、注入脚本改善 Mermaid 呈现

1. 注入方法

在 Typora 安装目录的 resources/app 目录下可以找到 window.html。通常是在下面这个位置:

C:\Program Files\Typora\resources\window.html

修改这个文件,在文件末(紧接 </body> 前)注入脚本:

<script type="module" defer="defer" async="async"
        src="file://{PATH_TO_INJECTION_SCRIPT}"></script>

如 (Windows):

<script type="module" defer="defer" async="async"
        src="file:///D:/etc/typora-extension/typora/injection.js"></script>

或 (Linux):

<script type="module" defer="defer" async="async"
        src="file:///etc/typora-extension/typora/injection.js"></script>

注:目前 injection.js 是采用 ESM 方式写的,所以需要 type = "module"

2. injection.js

injections.js 中通过配置 mermaidScript 变量指定最新版本的 Mermaid 脚本。mermaidConfig 可参考 Mermaid 官方配置说明进行配置。

injections.js 会根据自己的位置找到 mermaid.min.js 并注入到 Typora 中,但 Git Repo 中并不包含 mermaid.min.js 脚本,需要手工下载。

3. GET mermaid.min.js

PowerShell 下可以通过运行 get-mermaid.ps1 来获取 Mermaid 的脚本,但要注意,get-mermaid.ps1 会调用 curl 命令来下载。如果下载失败,可以手工从 https://unpkg.com/mermaid/dist/mermaid.min.js 下载 Mermaid 脚本。

4. dark.js

该文件已废弃

Mermaid 不同图表样式标准规范不同,通过注入样式调整 Dark 样式非常困难。已放弃这种方式,目前官方主题 forest 是最和谐的主题,默认采用 forest(可以在代码中修改 mermaidConfig 换其他主题)

injections.js 中将 mermaidConfig.theme 配置为 "dark"之后,可以引入 dark.js 对该主题样式进行优化,使之更美观、更易于阅读。注意:该扩展不宜用于其他主题。

目前 injection.js 只支持 dark 样式。如果需要使用其他样式,需要修改 injection.js 中的相关代码。

二、jamesfan 主题

该主题是根据个人习惯配置的,分为普通版本 (jamesfan.css) 和 indent 版本 (jamesfan-indent.css)。其中 indent 版本采用了中文段落首行缩进两格的设置。

主题使用 LESS 编写,需要编译成 CSS 之后使用。

目前没有提供 LESS 的编译脚本,编译由 VSCode 的扩展 Easy LESS 完成。VSCode 的 Workspace Recommendations (工作区推荐) 中会推荐此插件。

通过插件编译好的样式表文件放在 themes 目录(通过其他手段编译的请放入此目录),运行 publish-theme.ps1 可以自动发布到 Typora 主题目录。若不成功,请手工拷贝。

主题更新之后如果不生效,需要关闭所有 Typora 进程,重新打开 Typora 来应用。

三、目录结构

Hosting on Gitee: https://gitee.com/jamesfancy/typora-extention.git

~
├── .vscode             # VSCode 配置目录
│   ├── extensions.json
│   └── settings.json
├── themes              # 样式表输出目录
│   ├── jamesfan-indent.css
│   └── jamesfan.css
├── typora              # 源文件
│   ├── themes
│   │   ├── jamesfan-indent.less
│   │   └── jamesfan.less
│   ├── dark.js
│   └── injection.js
├── .editorconfig
├── .gitignore
├── get-mermaid.ps1     # 下载 mermaid.js 的 PowerShell 脚本,需要环境有 curl
├┄┄ mermaid.min.js      # 下载下来的 mermaid.js 放这里
├── publish-theme.ps1   # 把 themes 目录下的 *.css 拷贝到 Typora 主题文件夹
└── README.md
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

为 Typora 注入脚本,引入最新版本的 Mermaid 脚本,自定义 Mermaid 样式等。 展开 收起
Less 等 3 种语言
MulanPSL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/jamesfancy/typora-extension.git
git@gitee.com:jamesfancy/typora-extension.git
jamesfancy
typora-extension
typora-extension
main

搜索帮助

53164aa7 5694891 3bd8fe86 5694891