A document editor for .docformer and .docform files
Project description
DocFormer
DocFormer是一个简单的文档编辑器,支持创建和编辑.docformer格式的文本文件,并可以导出为HTML格式。
功能特点
- 创建和编辑.docformer格式的文本文件
- 导出为.docform格式,自动生成目录和格式化文本
- 支持多级缩进,自动调整字号
- 可以安装到系统中,支持命令行操作
- 提供文件夹配置功能,自动创建导出脚本
##安装要求
- 确保安装tkinter
安装方法
- 确保已安装Python 3.6或更高版本
- 运行以下命令安装:
pip install .
使用方法
图形界面
安装后,可以通过以下命令启动编辑器:
docformer
文件格式说明
.docformer格式
- 纯文本格式
- 使用缩进来表示层级关系
- 第一行为总标题
- 每个空格表示一级缩进
- 自动生成目录和对应编号
- 点击目录高亮跳转到对应块
- 鼠标悬浮在块上会高亮对应块
- 以\开头的行表示无需计入目录的注文
- 插入图片和文件([img:] 和 [file:])需要单起一行
HTML格式
- 包含目录和格式化文本
- 在文本前添加对应编号
- 自动根据缩进级别调整字号
- 最大缩进级别的字号为20px
- 每减少一级缩进,字号增加
- 插入的图片会直接显示,插入的文件会显示文件名,单击下载
示例
输入文件(.docformer):
总标题
一级标题
二级标题
三级标题
另一个一级标题
\正文
[img:path]
[file:path]
导出后的HTML文件将包含:
- 自动生成的目录
- 格式化的文本、图片和文件,字号根据缩进级别自动调整
- 保持原有的层级结构
许可证
MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docformer-1.0.0.tar.gz
(13.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
docformer-1.0.0-py3-none-any.whl
(12.8 kB
view details)
File details
Details for the file docformer-1.0.0.tar.gz.
File metadata
- Download URL: docformer-1.0.0.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd1435fae4468a557c949078fde9bc789cd3f9b2e0c0780a91bbb3d416a65fee
|
|
| MD5 |
230ba52bedf8936c0c7746e6090be1d6
|
|
| BLAKE2b-256 |
4150c42ba82b7fa4cbd43e1a5897fed7c1afd4404f727db15e34cc504ae2d33e
|
File details
Details for the file docformer-1.0.0-py3-none-any.whl.
File metadata
- Download URL: docformer-1.0.0-py3-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e860c0b064d6aa7b6af06c3c82c856f569b9c211f9912bb234b7875670478a0
|
|
| MD5 |
6398e636229f61b707e32af0649e2143
|
|
| BLAKE2b-256 |
48276b9f031aeda84a342bafd2c3d3c6f9761be77f255d4fd451680b87238eed
|