首页 > 其他分享 >README

README

时间:2024-01-05 16:15:18浏览次数:40  
标签:博客园 release 文档 右键 README 工具 图片

工具介绍

工具由来

对于程序员等常常需要写文档的人来说,将本地markdown文档同步到云端博客平台,是一件比较繁琐的事情,首当其冲的是,大量的本地图片需要"互联网"化,即使网络上不乏有些工具能做到将图片自动上传到某些图床来解决这个问题,但是还是需要自己手动复制文档到对应的博客平台,无法一步到位,总是有些"不美"

功能简述

本工具的目的就是希望能做到一键上传所有的图片以及包含转换后图片的markdown本身博客园

生态组合

本工具基于Java,针对windows平台(笔者所用为 windows 10),markdown编写工具为"所见即所得"的Typora,博客云端平台为博客园

工具获取

github:https://github.com/Cmy-art/md-uploader

release:https://github.com/Cmy-art/md-uploader/releases/tag/V1.0.0

可下载下图的release包

image-20240105155446561

配置说明

Typora配置

依次点击文件-偏好设置-图像-选择如下图的复制图片到./${filename}.asserts文件夹

目的是插入图片时,会自动在同级目录下生成文档名称.assets的文件夹来统一管理本地图片

image-20240105103621871

配置项说明

首先将release包固定存放到某个盘符路径,视为工作目录,工作目录修改需要重新执行步骤右键集成

打开release包,修改配置文件conf.txt

image-20240105105736484

文件中有四个配置项

  • url => MetaWeblog访问地址
  • username => MetaWeblog登录名
  • token => MetaWeblog访问令牌

前三个在博客园后台的,设置-博客设置-设置-其他设置中获取,如下图

image-20240105110426641

  • publish

    表示是否发布,0表示不发布,1表示直接发布,默认是0,按需修改

配置好后保存即可

右键集成

一键上传的实现方式是将脚本命令通过修改注册表集成到windows右键菜单

管理员身份运行release包中的init.bat命令,注意!该批处理命令中有修改注册表的操作,建议创建系统还原点或者备份注册表之后再操作(一般没啥问题)

image-20240105104534178

执行成功后,右键点击markdown文件,菜单中出现Upload Markdown文件

image-20240105105207843

使用示例

log

注意事项

  • 该工具基于Java,如果您的电脑存在Java环境(配置了JAVA_HOME)就会默认使用您自己的Jre,否则会直接使用release吧中的jre

  • 文档移动位置

    务必文档和其.asserts文件一起移动

  • 文件名修改

    文档名称请慎重决定(最好确定了就不在修改文档名称了)

    会导致生成多个.assert文件

    图片会重复上传

  • 文档内容可以正常变更

  • 大量图片的上传

    由于速度受限于接口的响应速度,所以如果文档中有大量图片可能需要一定时间才能上送完成

  • 关于文档的分类和tag等更细粒度的配置请到博客园管理页面配置

  • 接口变更

    如果博客园的接口变更可能导致上传失败

标签:博客园,release,文档,右键,README,工具,图片
From: https://www.cnblogs.com/void-cmy/p/17947156

相关文章

  • 读程序员的README笔记19_读后总结与感想兼导读
    1. 基本信息程序员的README[美]克里斯·里科米尼(ChrisRiccomini)(美)德米特里·里人民邮电出版社,2023年7月出版1.1. 读薄率书籍总字数203千字,笔记总字数40984字。读薄率40984÷203000≈20.19%1.2. 读厚方向演进式架构SRE:Google运维解密软件设计的哲学......
  • 读程序员的README笔记17_构建可演进的架构(下)
    1. 可演进的API1.1. 随着需求的变化,你需要改变你的API,即代码之间的共享接口1.2. 改变API很容易,但很难做到正确1.3. 保持API小巧1.3.1. 小巧的API更易于理解和演进1.3.2. 只添加即刻需要的API方法或字段1.3.3. 带有许多字段的API方法应该有合理的默认值1.3.3.1. 开......
  • 读程序员的README笔记13_技术设计流程(上)
    1. 行为准则2. 设计过程的螺旋式上升2.1. 圆锥体中的箭头进一步螺旋式上升2.2. 你现在更确定你理解了问题空间2.3. 你的原型为你的解决方案提供了越来越多的信心2.4. 随着每一次迭代,设计文档变得更加清晰和详细3. 技术设计流程3.1. 当被要求对系统进行修改时,大......
  • 读程序员的README笔记12_On-Call
    1. 行为准则2. On-Call工程师2.1. On-Call工程师是应对计划外工作的第一道防线,无论是生产环境问题还是临时支持请求2.2. 将深度工作与运维工作分开,可以让团队中的大多数人专注于开发任务2.3. On-Call工程师只需专注于不可预知的运维难题和支持任务3. On-Call的工作方......
  • 读程序员的README笔记07_测试(下)
    1. 自己动手编写测试1.1. QA团队可以帮助你验证你的代码是否稳定,但千万不要把代码直接丢给他们,然后让他们做所有的测试1.2. 避免硬编码的值,不要重复代码1.3. 专注于测试基本功能而不是实现细节,这有助于代码库的重构1.3.1. 测试代码在重构后仍然可以运行1.4. 将测试的......
  • 读程序员的README笔记06_测试(上)
    1. 行为准则2. 编写、运行和修复测试用例会让人感觉很忙碌2.1. 测试本身才更容易成为繁忙的工作2.2. 糟糕的测试会增加开发人员的开销而不提供价值,并且还会增加测试套件的不稳定性3. 测试用途3.1. 测试可以检查代码是否正常工作3.1.1. 测试本身就可以验证软件的行......
  • 读程序员的README笔记05_日志、监控与配置
    1. 行为准则2. 日志分级2.1. 日志框架设有日志级别,它可以让运维人员根据重要性过滤消息2.2. 编程语言有精良的日志类库,让运维人员对要记录的内容和时间有更多的控制2.3. TRACE2.3.1. 一个极其精细的日志级别2.3.2. 对特定的包或类开放2.3.3. 在开发阶段之外很少......
  • npm学习(九)之README.md文件
      包括文档(readme.md)npm建议您包含一个readme文件来记录您的包。自述文件必须有文件名readme.md。文件扩展名.md表示该文件是一个标记(markdown)文件。当有人发现您的包时,该文件将出现在npm网站上。在开始之前,请查看一些包页面,了解可以添加到readme文件中的信息,并了解为......
  • Github项目README美化 | Github徽章制作
    Github项目README美化|Github徽章制作1、前言平时逛Github开源项目的时候,经常看到README文件会有各式各样的小徽章,哈哈,你是不是也想在自己的项目上添加Github小徽章。让我们来看看别人的项目徽章。VueReact无疑,这样的Github徽章能合理的优化README的美化,能够更加地吸引别......
  • GitHub仓库的README文件无法显示图片问题-非域名污染原因
    之前上自己仓库就偶然发现图片不显示现象,当时以为是网络问题就没有留意这事。但是一直不显示就有问题了!于是网上搜了一遭,看见大家遇到此现象的原因普遍归于DNS污染1而我的问题原来是MarkDown格式!在图片语法前不要加分区语法“>”,否则尽管在本地能够显示图片,但GitHub显示如下:【小技......