如何备份 Outline 导出的 Markdown 文件

2024-04-01 14:04
文章标签 导出 备份 markdown outline

本文主要是介绍如何备份 Outline 导出的 Markdown 文件,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在这里插入图片描述

前面,我撰写了两篇文章,介绍了:

  • 《如何在本地环境安装 Outline》
  • 《使用 Outline 搭建企业、个人知识库面临的问题》

今天,我们继续这个话题。使用 Outline 搭建知识库,如何备份自己知识库内的资料。

Outline 底层使用数据库 PostgreSQL 和 Redis 作为异步队列的承载。其数据默认存储在 PostgreSQL 里,这和一般的 Markdown 文档系统不太一样,虽然底层本质上也是 Markdown 文档,但是却不是用纯文本格式来存储。这对备份和恢复不太友好。

前文已经介绍过,导入、导出的兼容性可能不太好,不过单纯使用导出的话,实测下来,我觉得还是可以依赖的。意思就是,你单方面在 Outline 编辑文档,然后定期导出后,进行备份,不再将导出的文档导入回 Outline 系统,站内的相对链接回失效,Outline 不能正确处理。

如何导出

在这里插入图片描述
在管理员界面,点击导出,选择 Markdown 格式,可以生成异步导出的压缩包,然后再点击下载,可以得到所有的导出文档。

此前已经说过,在 Outline 里,嵌入的图片,链接都是指向自己的 Server,而不是指向图片所在的真实地址,当你导出后,你会发现,图片什么的都正常导出了,而文章中的链接也替换成了导出目录的相对链接,这一点到让我挺满意的,超出我的预期。

不过,因为 Outline 系统自己会根据每个文档集的情况,在网站左侧建立导航栏,所以,你导出的全部文档,是一个一个的文档集的目录。没有所有文档的索引,如果你要把导出的文档,都上传的 Git 去备份的话,查看这些文档是比较让人困扰的。

如何自助建立索引

不过这难不倒程序员,我们可以用 Python 扫描所有的目录,然后,按照目录的结构,手动建立一个索引,比如,我利用 Gitlab 的 Wiki 来备份我导出的所有文档,所以,我需要一个 home.md 和 _sidebar.md 来展示我整个文档集的索引。

import osdef build_tree(path):tree = {'name': os.path.basename(path), 'children': []}if os.path.isdir(path):all_children = os.listdir(path)for child in sorted(all_children):child_path = os.path.join(path, child)if child in ['home.md', '_sidebar.md', '.git', 'public', 'index.py']:continueif os.path.isdir(child_path):if child in [os.path.splitext(x)[0] for x in all_children if x.endswith('.md')]:sub_tree = build_tree(child_path)sub_tree['link'] = os.path.join(path, child)tree['children'].append(sub_tree)else:tree['children'].append(build_tree(child_path))else:if os.path.splitext(child)[0] not in [x for x in all_children if not x.endswith('.md')]:tree['children'].append({'name': child, 'children': []})return treedef write_line(file, level, name, link=None, isTitle=False):indent = '  ' * (level - 1)linkStr = ''if link is None:linkStr = f"{name}"else:linkStr = f"[{name}]({link})"if isTitle:file.write(f"{indent}* **{linkStr}**\n")else:file.write(f"{indent}* {linkStr}\n")def write_tree(tree, home, sidebar, path='', level=1):if 'children' in tree:if tree['name'] != '.':if len(tree['children']) > 0:write_line(home, level, tree['name'], tree.get('link'), isTitle=True)write_line(sidebar, level, tree['name'], tree.get('link'))else:filename = os.path.splitext(tree['name'])[0]write_line(home, level, filename, os.path.join(path, filename))write_line(sidebar, level, filename, os.path.join(path, filename))for child in tree['children']:write_tree(child, home, sidebar, os.path.join(path, tree['name']), level + 1)tree = build_tree('.')
with open("home.md", "w") as home, open("_sidebar.md", "w") as sidebar:home.write("<!--本文件使用 index.py 生成,请勿修改本文件-->\n")sidebar.write("<!--本文件使用 index.py 生成,请勿修改本文件-->\n")write_tree(tree, home, sidebar)

这段代码是我用 ChatGPT 生成的,其作用主要是:

  • build_tree 扫描所有的目录和文件,按照原有的目录结构,建立一个目录树;
  • write_tree 递归打印目录树,按照原有目录层级,处理缩进,生成一个美观的索引文件;
  • 将索引写入 home.md 和 _sidebar.md

这样我们就可以为自己导出的文档,生成一个美观的索引目录:

在这里插入图片描述
这是我将所有的文档,提交到 Gitlab 后,渲染出来的 home.md 文件。这样 Outline 也可以当成是一个文档集的编辑器来用。

总结

本文介绍了,如何从 Outline 知识库中导出文档,以及导出的文档缺乏索引的情况下,如何自己编写代码来生成一个索引文件 home.md 和 _sidebard.md。

这篇关于如何备份 Outline 导出的 Markdown 文件的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/867343

相关文章

Oracle数据库定时备份脚本方式(Linux)

《Oracle数据库定时备份脚本方式(Linux)》文章介绍Oracle数据库自动备份方案,包含主机备份传输与备机解压导入流程,强调需提前全量删除原库数据避免报错,并需配置无密传输、定时任务及验证脚本... 目录说明主机脚本备机上自动导库脚本整个自动备份oracle数据库的过程(建议全程用root用户)总结

SpringBoot集成EasyPoi实现Excel模板导出成PDF文件

《SpringBoot集成EasyPoi实现Excel模板导出成PDF文件》在日常工作中,我们经常需要将数据导出成Excel表格或PDF文件,本文将介绍如何在SpringBoot项目中集成EasyPo... 目录前言摘要简介源代码解析应用场景案例优缺点分析类代码方法介绍测试用例小结前言在日常工作中,我们经

SpringBoot+EasyPOI轻松实现Excel和Word导出PDF

《SpringBoot+EasyPOI轻松实现Excel和Word导出PDF》在企业级开发中,将Excel和Word文档导出为PDF是常见需求,本文将结合​​EasyPOI和​​Aspose系列工具实... 目录一、环境准备与依赖配置1.1 方案选型1.2 依赖配置(商业库方案)二、Excel 导出 PDF

SpringBoot+EasyExcel实现自定义复杂样式导入导出

《SpringBoot+EasyExcel实现自定义复杂样式导入导出》这篇文章主要为大家详细介绍了SpringBoot如何结果EasyExcel实现自定义复杂样式导入导出功能,文中的示例代码讲解详细,... 目录安装处理自定义导出复杂场景1、列不固定,动态列2、动态下拉3、自定义锁定行/列,添加密码4、合并

k8s上运行的mysql、mariadb数据库的备份记录(支持x86和arm两种架构)

《k8s上运行的mysql、mariadb数据库的备份记录(支持x86和arm两种架构)》本文记录在K8s上运行的MySQL/MariaDB备份方案,通过工具容器执行mysqldump,结合定时任务实... 目录前言一、获取需要备份的数据库的信息二、备份步骤1.准备工作(X86)1.准备工作(arm)2.手

一文详解MySQL如何设置自动备份任务

《一文详解MySQL如何设置自动备份任务》设置自动备份任务可以确保你的数据库定期备份,防止数据丢失,下面我们就来详细介绍一下如何使用Bash脚本和Cron任务在Linux系统上设置MySQL数据库的自... 目录1. 编写备份脚本1.1 创建并编辑备份脚本1.2 给予脚本执行权限2. 设置 Cron 任务2

C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式

《C#实现将Office文档(Word/Excel/PDF/PPT)转为Markdown格式》Markdown凭借简洁的语法、优良的可读性,以及对版本控制系统的高度兼容性,逐渐成为最受欢迎的文档格式... 目录为什么要将文档转换为 Markdown 格式使用工具将 Word 文档转换为 Markdown(.

使用Python实现网页表格转换为markdown

《使用Python实现网页表格转换为markdown》在日常工作中,我们经常需要从网页上复制表格数据,并将其转换成Markdown格式,本文将使用Python编写一个网页表格转Markdown工具,需... 在日常工作中,我们经常需要从网页上复制表格数据,并将其转换成Markdown格式,以便在文档、邮件或

Mac备忘录怎么导出/备份和云同步? Mac备忘录使用技巧

《Mac备忘录怎么导出/备份和云同步?Mac备忘录使用技巧》备忘录作为iOS里简单而又不可或缺的一个系统应用,上手容易,可以满足我们日常生活中各种记录的需求,今天我们就来看看Mac备忘录的导出、... 「备忘录」是 MAC 上的一款常用应用,它可以帮助我们捕捉灵感、记录待办事项或保存重要信息。为了便于在不同

Python+PyQt5实现MySQL数据库备份神器

《Python+PyQt5实现MySQL数据库备份神器》在数据库管理工作中,定期备份是确保数据安全的重要措施,本文将介绍如何使用Python+PyQt5开发一个高颜值,多功能的MySQL数据库备份工具... 目录概述功能特性核心功能矩阵特色功能界面展示主界面设计动态效果演示使用教程环境准备操作流程代码深度解