1 Star 6 Fork 1

二境志 / ideal-yuque-md-refactor

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

ideal-yuque-md-refactor

1. 介绍 🤔

1.1 项目定位:

一款支持语雀 markdown 文件导出后的格式修复工具,包含图片有序本地化,段间距格式处理等操作。治好你的强迫症,解放双手专心码字。

如果想要沉淀去写一些技术积累和生活,语雀是目前为止我用起来比较顺手的平台工具,但是我自己本身有多台机器,也有备份的习惯,所以本地坚果云都会同步备份,以备不时之需。

语雀编辑器本身是一个富文本兼容 markdown 语法的特色编辑器,确实体验效果很好。不过也正因为如此,到处 markdown 的时候,会有一些不完全兼容的地方,因此开发了这个工具,后面会陆续更新一些功能。

功能

  • 图片多余后缀处理
    • 处理后可在联网情况下以语雀图床的方式显示
  • 图片本地化
    • 目前默认会在源文件目录下生成 images 文件夹,以数字 1 开始递增命名,例如 1.png ,请保证文件夹内只有数字命名的文件
  • 段间距调整
    • 请保证导出时选择了 “导出保持语雀的换行”
  • LaTeX 公式兼容
  • 指定文件输出目录
    • 当前基于源文件覆盖输出。
  • 自动处理文件夹下的所有 markdown 文件
    • 包括子目录
  • 目前够了?

1.2 技术博客:

1.3 使用场景:

  1. 图片不兼容
  2. 图片本地化
  3. 段间距调整

部分错误效果

2. 使用说明 📔

2.1 环境:

  1. JDK 1.8+ 、
  2. Maven 3.x+
  3. IDEA 编译器(打 jar 包后命令跑也行)

说明:

  1. 目前没打成 jar,调用方式也是通过 http 请求,当然也可以直接走单元测试。
  2. 日志在控制台输出,没配 logback。

2.3 使用步骤

  1. 在具备 Java 环境的前提下,导入到 IDEA 编译器,启动 BootApplication,端口号为 8081,可在 application.yaml 中修改
  2. 语雀导出时,“导出保持语雀的换行”
  3. 复制出自己保存文件的绝对路径,例如:/Users/ideal/Desktop/test/待处理md文件.md
  4. 通过 Postman /ApiFox 等工具 HTTP 请求接口(下方有介绍),或者单元测试自己启动。

2.2 接口:

重要说明:如果不指定都是覆盖源文件重构,源文件不会保留, 请一定备份!!!而且请保证源文件不被占用,否则会报错

POST /refactor/refactorByLocalPath

请求参数

名称 位置 类型 必选 说明
localFilePath query string 本地文件路径
pathType query integer 路径类型 文件路径类型-1 文件夹类型-2
targetDirPath query string 指定输出路径
dirRecursive query string 递归开关 0-关闭 1-开启(文件夹需传 默认关闭)
localImgRelativePath query string 图片生成相对于文件的路径( 默认 images)
newImgNameStrategy query string 图片命名策略(暂时没用,都是数字递增处理)

举例 1: 覆盖重构指定单个 markdown 文件(如果想要指定输出目录,则指定 targetDirPath)

  • localFilePath = /Users/ideal/Desktop/test/待处理md文件.md
  • pathType = 1

**举例 2:**重构指定文件夹下的所有 markdown 文件,并且保留原来的层级格式输出到指定目录。

  • localFilePath = /Users/ideal/Desktop/test/doc
  • pathType = 2
  • targetDirPath = /Users/ideal/Desktop/test/new-doc
  • dirRecursive = 1

返回示例

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

2.3 效果

修复效果

3. 更新日志

2022.10.31 更新

  1. 提交通过 Http 请求的单 markdown 文件覆盖修复初始版本

2022.11.03 更新

  1. 支持了LaTeX 公式处理
  2. 支持指定文件输出目录
  3. 支持自动处理文件夹下的所有 markdown 文件
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

一款支持语雀 markdown 文件导出后的格式修复工具,包含图片有序本地化,段间距格式处理等操作。治好你的强迫症,解放双手专心码字。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/ideal-20/ideal-yuque-md-refactor.git
git@gitee.com:ideal-20/ideal-yuque-md-refactor.git
ideal-20
ideal-yuque-md-refactor
ideal-yuque-md-refactor
master

搜索帮助