Skip to main content

A document editor for .docformer and .docform files

Project description

DocFormer

DocFormer是一个简单的文档编辑器,支持创建和编辑.docformer格式的文本文件,并可以导出为HTML格式。

功能特点

  • 创建和编辑.docformer格式的文本文件
  • 导出为.docform格式,自动生成目录和格式化文本
  • 支持多级缩进,自动调整字号
  • 可以安装到系统中,支持命令行操作
  • 提供文件夹配置功能,自动创建导出脚本

##安装要求

  • 确保安装tkinter

安装方法

  1. 确保已安装Python 3.6或更高版本
  2. 运行以下命令安装:
pip install .

使用方法

图形界面

安装后,可以通过以下命令启动编辑器:

docformer

文件格式说明

.docformer格式

  • 纯文本格式
  • 使用缩进来表示层级关系
  • 第一行为总标题
  • 每个空格表示一级缩进
  • 自动生成目录和对应编号
  • 点击目录高亮跳转到对应块
  • 鼠标悬浮在块上会高亮对应块
  • 以\开头的行表示无需计入目录的注文
  • 插入图片和文件([img:] 和 [file:])需要单起一行

HTML格式

  • 包含目录和格式化文本
  • 在文本前添加对应编号
  • 自动根据缩进级别调整字号
  • 最大缩进级别的字号为20px
  • 每减少一级缩进,字号增加
  • 插入的图片会直接显示,插入的文件会显示文件名,单击下载

示例

输入文件(.docformer):

总标题
一级标题
 二级标题
  三级标题
另一个一级标题
\正文
[img:path]
[file:path]

导出后的HTML文件将包含:

  • 自动生成的目录
  • 格式化的文本、图片和文件,字号根据缩进级别自动调整
  • 保持原有的层级结构

版本说明

  • 1.0.x版本均为初始测试版本,小版本更新仅对于程序架构进行少量修改

许可证

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.4.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docformer-1.0.4-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file docformer-1.0.4.tar.gz.

File metadata

  • Download URL: docformer-1.0.4.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for docformer-1.0.4.tar.gz
Algorithm Hash digest
SHA256 bb00cea1d4c0dd8cee7010d73da8e5da42116e30ccb7a2e6ece9b8f28e2a003c
MD5 fbd18911825290f6703526995525cd93
BLAKE2b-256 be922e762638bd7728d8b0d7c8ea5a69a3feedf03883d2f1f9f11fbf565e6fb1

See more details on using hashes here.

File details

Details for the file docformer-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: docformer-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for docformer-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f0875a2824d70886529f2d747d356b5a5dd2bf9a4dfe7ec87deebbed58379e08
MD5 6e8c8a9209cddc089772c7e8af083546
BLAKE2b-256 79fea91ea725a1c2a12c4af8704d35a802f9232a9242df7359f47d182b0c8772

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page