Skip to content

🕹一键生成指定格式markdown文件及一键进行git提交文件的小工具。用于方便生成算法题解框架并在完成后提交到仓库

Notifications You must be signed in to change notification settings

ustcyyw/markdown-git_tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown_tool & Git_tool

项目简介

  • 总结leetcode题解时使用的md文件格式固定,且要带上固定的落款(一些小广告),并且要将题解放到自己的github仓库(题解仓库点击here)。
  • 固定格式框架,提交到github的“add commit push”三步曲都是重复性劳动,不如用个工具解决麻烦吧(依旧是兴趣驱动的小玩具)。
  • markdown_tool用于一键生成题解框架;git_tool用于一键将文件提交到github()。
  • 由于扩展性较差,下面两个链接是对markdown_tool, git_tool的一些实现细节的介绍,可以看懂这个思路然后自己造属于自己的小工具来方便自己呀:

效果展示

markdown_tool:

  • 可以生成仅有一种解法的题解框架。

    md_tool_one_solve.png
    • 题目名称填入Leetcode算法题的名称;
    • 文件名称的输入不需要后缀.md;
    • 生成文件存放的路径可以自己设置(查看markdown_tool_readme)
  • 可以生成2种或者多种解法的题解框架。 md_tool_two_solve.png

    • 在“解法数目”处填入解法数目。

git_tool:

  • 提交仓库中所有新文件。
    • git_tool展示1.png
    • 选择仓库,填写commit的内容,文件名处填入“*”后点击确定。
  • 提交仓库中的指定文件。
    • git_tool展示2.png
    • 选择仓库,填写commit的内容,文件名处填入指定的文件名(不能省略文件后缀),后点击确定。
    • 这里要确保仓库中没有重名的文件(哪怕他们的相对路径并不同),此小bug是将来可以补齐的地方。

错误示范及改正方式

markdown_tool:

md_tool_error.png

  • 左边:解法数目输入错误,只能输入大于0的整数。
  • 右边:文件名中出现非法字符,不能输入非法的文件名字符。

git_tool:

  • 错误或者警告.png * 第一个错误:使用前先单选选定一个要提交文件的仓库。 * 第二个错误:仓库中的文件名一定要写对,且别忘记后缀,如果不是需要单独提交某个文件,可以使用默认添加所有文件"*"。 * 警告:选择了仓库且制定文件确实存在,但是已经不需要提交了,就会发出“文件已提交”的警告。 * 并且注意,这个小工具只针对 add commit push的三连操作,其它git的命令不能使用它。

本地使用

  • 首先fork这个库(并且给个❤️star),然后clone到本地,修改配置类中的配置。然后根据项目结构图搭建项目框架,然后将java程序打包成jar,再自己做一个.bat文件来运行jar就行。
  • 我使用的maven搭建项目,如果你也是这样,可以将pom文件也放置到合适位置,不需要修改pom文件(除非你改了主类名字),然后利用maven的打包命令就可以生成jar。如果你使用JB家的IDEA,并且使用maven创建项目,可以参考我的笔记。其他情况就去百度/Google。
  • 在GUI页面按要求输入参数一键生成即可(下拉看更详细的介绍)

思路分享:

  • markdown_tool:
    • typora或者一些其它支持md格式的网页都是将字符串渲染成固定格式。
    • 所以只需要在md文件中输入固定格式的字符串,就可以达到设定格式,添加内容的目的!
  • git_tool:
    • 就是将add commit push三个命令行在程序中自动执行。
    • 需要添加commit的内容,需要知道往哪一个仓库添加什么文件,这就需要进行文件相关的检索。
  • 如果每次都需要打开ide再运行或者使用命令行传参数很麻烦,不如做个简单的GUI,再打包成jar,然后通过命令后来开启小工具会很方便!

欢迎交流

  • 如果觉得有用请给我一个星星吧~感谢给我 star 的小伙伴!可以fork去自己使用呀。
  • 如果有什么问题可以私信:

About

🕹一键生成指定格式markdown文件及一键进行git提交文件的小工具。用于方便生成算法题解框架并在完成后提交到仓库

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published