1 Star 2 Fork 0

brt2 / md2blog

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

My Notebook in Markdown

设计目标

  • 文档存储
    • 可下载link图像,进行本地化存储
    • 压缩内嵌图像,最小化上传
  • 支持随时浏览 & 快速查找
    • 同步到cnblog!
    • 支持mkdocs的发布
    • 支持hugo编译成静态文件

各平台的对比

  • cnblog
    • 支持查找
    • 无需搭建个人服务器
    • 不支持文档排序
  • mkdocs
    • 支持动态修改md和实时渲染
    • 支持主题切换
    • 需要个人服务器(内网限制)
  • gitbook(hugo/hexo)
    • 支持hugo多皮肤更换
    • 使用git快速部署,无需个人服务器
    • 尚不支持查找功能(待确认)
    • 不支持动态更新,编译的过程较复杂

流程设计

  1. 编写md文档,或使用“简阅”下载markdown
  2. 修改文档内容,可以正常在本地浏览器渲染即可
  3. 通过封装好的git_push.sh执行上传
    • 利用fmt_md.py格式化文档
      • head元数据
      • 去除H1标题
      • 检测权重,通过权重配置mkdocs的目录结构
    • 选择是否下载link图像(download_img_link.py)
    • 图片压缩(png2jpg_md_img.py)
    • 使用db_mgr.py对文档树进行管理
    • upload_cnblog.py上传到“博客园”
    • git commit & push 当前仓库

规范要求

  • 目录

    应该按照一定的分类标准,对所有的文档进行放置。

  • 文件命名

    关于blog的title采用如下策略:

    • 优先使用"description": 一句吸引人眼球的标题,例如:“他写微信软文赚了1173万元,愿意手把手教你文案秘籍——只在这周六”(博客也需要标题党)
    • "title": 如果"description"为空(默认),则使用title作为标题,这个可以“程序化”,简洁明了——“git rebase 使用技巧”
    • 文件名仅用于本地文件记录,与blog的title并不对应。
    • 文件名影响mkdocs的排序:
      • 文件名是mkdocs的默认排序规则
      • mkdocs通过程序,索引文章的weight,并记录于_index.md中
  • 标签

    通过hugo_info记录标签,并跟踪至数据库json中(由于db不支持git跟踪,改为json)。

  • git管理

    可以直接使用git来指示upload_cnblog.py对文档的上传管理:

    1. 对于需要上传或更新的文档,使用 git add 添加到repo中
    2. 执行 python3 upload_cnblog.py -a 自动查询当前repo的变化
    3. upload_cnblog格式化Markdown文件,上传至cnblog,并改写本地数据库表
    4. 自动更新当前repo——由于added文档格式化,需要重新add。同理图像目录也需要重新添加仓库,以及 .database.json 数据库
    5. 实现对 git commit 的提交
  • 简化操作

    • 创建新文件时使用格式模板
    • 上传时自动格式化Markdown文件
    • 自动对Headings排序,生成层级索引——“1.2.4”
    • 图像不会进行重复上传
    • 自动压缩图像,减小空间占用
    • 自动png转jpg
    • 支持过高分辨率的resize压缩
    • 自动实现category的管理
    • 支持label管理
    • 支持文档目录自动生成

使用

# 创建Git-Repo
cd REPO_DIR
git init
...

# 创建配置文件,初始化仓库路径
git clone git@gitee.com:brt2/md2blog.git
cd md2blog
python3 upload_cnblog.py -r REPO_DIR

cp demo/cnblog.json .cnblog.json
# 修改 .cnblog.json 文件,具体配置内容见:"配置文件 .cnblog.json 的说明"
vi .cnblog.json

# 编辑markdown
cd REPO_DIR
vi test.md

# 方式1: 手动上传
python3 upload_cnblog
在此拖入md文档,回车上传~

# 方式2: 使用自动上传功能
git add test.md
python3 upload_cnblog.py -a
根据需要,手动push你的Git仓库

上传方式推荐2,可以将内容commit提交到git。另,这个方式会自动将文件记录到数据库(json)中,便于修改、移动、删除文档时追踪文件。

配置文件 .cnblog.json 的说明

  • blog_url: "https://rpc.cnblogs.com/metaweblog/brt2"
  • blog_id: "anything" # cnblog并不验证此项目,尽管你能够获得你的ID
  • app_key: "brt2",
  • user_id: "2039866", # 此项用于下载图像链接时,忽略自己博客的图像地址
  • username: "brt2",
  • password: "this is a secret",
  • repo_dir: "D:\Home\workspace\note" # 指向你的Git-Repo

关于 user_id ,特别说明下:并没有明确的接口可以获取到该ID,它不同于blog_id。本人获取这个的方法是,上传一张图像后,查询其生成的URL地址,从中提取,例如: https://img2020.cnblogs.com/blog/2039866/202006/2039866-20200602142016960-1926272797.jpg 中可以提取到我的user_id: 2039866

Markdown编辑工具推荐

基于vscode

  • Markdown Shortcuts: 支持各种md格式化,最牛的就是自动生成表格的功能
  • Markdown TOC
  • Markdown AutoTOC
  • markdown-helper
  • Paste Image
  • Markdown Preview Enhanced(其实vscode默认md预览就很棒了)
  • Open In Default Browser(这个就很鸡肋了,还不如vscode自带预览功能)

基于sublime

  • Markdown Editing
  • Markdown Preview: 只能在浏览器中预览
  • imagepaste: 这个强烈推荐,可以直接粘贴剪切板图片,并存储在同名目录下。
    • 标准的插件,有个瑕疵: 只能存储为png图像,图像体积较大
    • 不支持Linux系统(个人测试未实现功能)
    • 推荐个人修改版本,默认存储jpg格式,且支持Linux: https://gitee.com/brt2/subl_imgpaste2
  • SublimeTmpl: 用于生成各类文件的模板,包括Markdown
  • 还有sublime自定义快捷键的功能,可以快速实现对H2/H3...等常见结构的格式化

基于Simpread(简阅)

  • 安利一下这款国人开源工具,工具后台已经对上百个常见网站做了适配,可以直接将html页面转码Markdown下载。
  • 当然,下载的格式毕竟还是有必要人工修整一下的,但已经节约了90%的时间了,知足吧
  • 本工具会自动再上传时标记【转载】字样,同时建议用户保留 本文由 简悦 SimpRead 转码, 原文地址... 的内容。

关于Markdown的格式(模板)

<!--
+++
title       = "This is title to show!"
description = ""
date        = "2020-06-01"
weight      = 5
tags        = ["我的标签"]
categories  = ["我的分类", "我的另一个分类"]
keywords    = []
+++ -->

[TOC]

## This is a heading

Body text...

* item_0
* item_1
    - item_1_1
    - item_1_2
* item_3

## This is another heading

Body text...

功能列表

  • 压缩图像(依赖pngquant,python3-pngquant)

    python3 main.py -s

    然后拖拽需要压缩的图像到命令行窗口即可(支持多选)。

  • 下载html,并自动转换为Markdown

    python3 main.py -d
  • 下载博客中链接的http图像为本地图片,并更新markdown图像引用地址

    python3 main.py -p

Todo List

  • 实现对多余图像的挑选和删除
  • 对于分辨率过高的图像进行resize操作
  • 实现git_rename、git_move操作
  • 已上传图像的link需要再次验证上传
  • 实现从cnblog获取database,更新本地json数据库
  • 通过url下载html并转换为MarkDown格式
  • 在post上传时,添加博客园的tag标签

Buglist

  • 通过上传md时,在post_struct["categories"]增加"[文章分类]",无法解决上传作为“文章”类型的问题。暂时没有方式可以实现该需求。
  • 目前cnblog不支持webp的动图格式,但测试webp比gif压缩率更高;所以建议手动转换webp -> gif,上传cnblog后,源文档 <!-- 注释 xxx.webp --> 保留并git存储webp原图和gif转换图。
  • html2text使用空格缩进来处理 <code> ,容易实现但无法体现代码语言类型,需要改成反引号的格式。

寻求帮助

欢迎各界高手施以援手,答疑解惑~

  • 如何将内容直接发布到“文章”中?
  • 如何使用博客园API,实现对博客园“收藏”等内容的管理?
GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

使用Markdown编写博客,并一键发布到博客园 + git仓库管理 展开 收起
Python
GPL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/brt2/md2blog.git
git@gitee.com:brt2/md2blog.git
brt2
md2blog
md2blog
v1.x

搜索帮助