markdown 写技术文档以及左侧树

#准备工作
最近准备开始编写技术文档,现在基本上都是开始使用md了,之前使用开源中国的文档编辑来做的,但是最近他的服务关闭了,然后转移到码云的企业版本了,不太想用企业版本服务就想找找其他的,现在使用的是vscode
依赖的插件
markdown previews enhancde 用来预览和生产html
markdown table prettifier 用来格式化biaoge
markdwon toc 用来生产文档 (需要把) file的eol换为\n settings修改
装上这些工具及可以写自己的文档了
#生成左侧树
这个工具真的是不好找,基本上网上都
https://github.com/i5ting
这个哥们五年前写的一套,但是文档有好多不是很好
然后找到了
https://github.com/huyande/MarkdownTemplate
这个几个月前的数据,有了很大的提升,使用之后有bug,并且每次贴进去有点繁琐,我有自己的网站,每次复制进去感觉很麻烦,因为html也是每次都生成的,然后就有了自己改的版本

$(document).ready(function(){
			$(".markdown-body").load("生成的文档",function(){
				$('#tree').ztree_toc({
                is_auto_number:false,
                documment_selector:'.markdown-body',
                is_expand_all: true
            });
			$('#readme').height($('.markdown-preview div').height() + 500);
			setTimeout(function(){
				$('#readme').height($('.markdown-preview div').height() + 500);
			},2000)
			});
        });

只要把自己生成的文件换下文件名就可以了
#流程

  1. vscode 安装插件
  2. 编写自己的文档,需要自己带标题
  3. 生成html
  4. 把自己的html名称到这个html替换下
  5. 发布,以后只需要发布自己的html就可以了
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 好的,下面是一份 PySide6 上手文档: ## 什么是 PySide6? PySide6 是一个 Python 库,它提供了用于创建 GUI 应用程序的工具。它使用 Qt 库作为后端,允许开发人员创建跨平台的 GUI 应用程序(支持 Windows、Linux 和 MacOS 等操作系统)。 ## 如何安装 PySide6? 要安装 PySide6,您需要先安装 Python 和 pip。然后,您可以使用 pip 命令安装 PySide6: ``` pip install pyside6 ``` ## 如何使用 PySide6? 要使用 PySide6,您需要先导入 PySide6 库: ```python import PySide6 ``` 然后,您可以使用 PySide6 库中的各种类和函数来创建 GUI 应用程序。例如,要创建一个简单的窗口,可以使用 PySide6 中的 `QMainWindow` 类: ```python import PySide6.QtWidgets app = PySide6.QtWidgets.QApplication() window = PySide6.QtWidgets.QMainWindow() window.show() app.exec_() ``` 这会创建一个空白的窗口,并在用户关闭窗口时退出应用程序。 您还可以使用 PySide6 库中的其他类和函数来创建按钮、菜单、布局等等。有关 PySide6 的更多信息,请参阅 [PySide6 文档](https://pyside6.readthedocs.io/)。 ### 回答2: PySide6 是一款基于 Qt 框架的 Python 第三方库,它提供了与 Qt 库相对应的 API,用于开发跨平台的图形用户界面 (GUI) 应用程序。使用 Markdown 来编 PySide6 的上手文档可以更好地结构化和呈现相关信息。 ## 安装 PySide6 首先,确保已经正确安装了 Python 解释器和相应的开发环境。然后,通过以下命令安装 PySide6: ``` pip install PySide6 ``` ## Hello World 示例 以下是一个简单的 Hello World 示例,用于验证 PySide6 的安装是否成功。创建一个名为 `hello.py` 的文件,并输入以下代码: ```python import sys from PySide6.QtWidgets import QApplication, QLabel app = QApplication(sys.argv) label = QLabel("Hello World!") label.show() sys.exit(app.exec()) ``` 然后,在终端中运行以下命令来启动应用程序: ``` python hello.py ``` 如果一切顺利,应该会看到一个显示着 "Hello World!" 的窗口。 ## 进阶使用 了解了基础示例后,可以开始探索更多 PySide6 的功能和用法。可以参考 PySide6 的官方文档(https://doc.qt.io/qtforpython/),其中包含了详细的 API 参考、教程和示例。 此外,还可以参加 PySide6 的社区论坛、在线课程和开发者大会,与其他开发者交流经验和解决问题。 ## 总结 通过 Markdown的 PySide6 上手文档使得阅读和理解更加方便。以上只是一个简单的入门指引,希望能够帮助你快速上手 PySide6 开发。请继续深入学习和探索,享受使用 PySide6 构建强大的 GUI 应用程序的乐趣! ### 回答3: PySide6是一款用于创建图形用户界面(GUI)的Python库。对于那些希望快速上手PySide6的开发者来说,使用Markdown来编上手文档是一种简洁有效的方式。 PySide6安装: 要使用PySide6,首先需要将其安装到Python环境中。可以通过运行以下命令来安装PySide6: ``` pip install PySide6 ``` 创建PySide6应用程序: 创建一个基本PySide6应用程序有以下几个步骤: 1. 导入必要的模块: ```python from PySide6.QtWidgets import QApplication, QLabel ``` 2. 创建应用程序对象: ```python app = QApplication([]) ``` 3. 创建窗口对象: ```python label = QLabel('Hello PySide6!') ``` 4. 将窗口显示出来: ```python label.show() ``` 5. 运行应用程序的主循环: ```python app.exec() ``` 更复杂的PySide6应用程序可以使用其他PySide6模块来创建按钮、文本框、标签等图形组件,并为这些组件添加事件处理器。 事件处理: 可以使用PySide6的信号-槽(Signal-Slot)机制来处理各种事件,例如按钮被点击时的事件。 1. 导入所需的模块: ```python from PySide6.QtWidgets import QPushButton from PySide6.QtCore import Slot ``` 2. 创建按钮对象和事件处理器: ```python button = QPushButton('Click me') @Slot() def on_button_clicked(): print('Button clicked!') ``` 3. 将事件处理器连接到按钮的点击事件: ```python button.clicked.connect(on_button_clicked) ``` 以上是PySide6的基本用法。使用Markdown的上手文档提供了简洁的步骤和示例代码,能够帮助开发者快速上手并开始开发PySide6应用程序。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值