From 48077716076121f1552f159d14dff85fce692da6 Mon Sep 17 00:00:00 2001
From: xunbu <xunbu3@qq.com>
Date: Thu, 8 May 2025 17:15:34 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .idea/workspace.xml         | 68 +++++++++++++++++++------------------
 README.md                   | 16 ++++++++-
 docutranslate/translater.py |  4 ++-
 3 files changed, 53 insertions(+), 35 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index b9c7096..866edb2 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -7,6 +7,7 @@
     <list default="true" id="6b18b44a-df57-4212-a857-9e291ebe5dd2" name="更改" comment="">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docutranslate/translater.py" beforeDir="false" afterPath="$PROJECT_DIR$/docutranslate/translater.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -32,38 +33,38 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "DefaultHtmlFileTemplate": "HTML File",
-    "JavaScript 调试.output.html (1).executor": "Run",
-    "JavaScript 调试.output.html.executor": "Run",
-    "JavaScript 调试.regex_中文.html.executor": "Run",
-    "JavaScript 调试.test2_英文.html.executor": "Run",
-    "ModuleVcsDetector.initialDetectionPerformed": "true",
-    "Python 测试.Python 测试 (markdown_mask.py 内).executor": "Run",
-    "Python 测试.markdown_mask.Test.test_basic_link_masking 的 Python 测试.executor": "Run",
-    "Python.PDFtranslater (1).executor": "Run",
-    "Python.PDFtranslater (2).executor": "Run",
-    "Python.agent_utils.executor": "Run",
-    "Python.convert.executor": "Run",
-    "Python.markdown_splitter.executor": "Run",
-    "Python.markdown_utils.executor": "Run",
-    "Python.test.executor": "Run",
-    "Python.test1.executor": "Run",
-    "Python.translater.executor": "Debug",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "RunOnceActivity.git.unshallow": "true",
-    "git-widget-placeholder": "main",
-    "last_opened_file_path": "C:/Users/jxgm/Desktop/FileTranslate/tests/resource",
-    "node.js.detected.package.eslint": "true",
-    "node.js.detected.package.tslint": "true",
-    "node.js.selected.package.eslint": "(autodetect)",
-    "node.js.selected.package.tslint": "(autodetect)",
-    "nodejs_package_manager_path": "npm",
-    "settings.editor.selected.configurable": "Errors",
-    "vue.rearranger.settings.migration": "true"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;DefaultHtmlFileTemplate&quot;: &quot;HTML File&quot;,
+    &quot;JavaScript 调试.output.html (1).executor&quot;: &quot;Run&quot;,
+    &quot;JavaScript 调试.output.html.executor&quot;: &quot;Run&quot;,
+    &quot;JavaScript 调试.regex_中文.html.executor&quot;: &quot;Run&quot;,
+    &quot;JavaScript 调试.test2_英文.html.executor&quot;: &quot;Run&quot;,
+    &quot;ModuleVcsDetector.initialDetectionPerformed&quot;: &quot;true&quot;,
+    &quot;Python 测试.Python 测试 (markdown_mask.py 内).executor&quot;: &quot;Run&quot;,
+    &quot;Python 测试.markdown_mask.Test.test_basic_link_masking 的 Python 测试.executor&quot;: &quot;Run&quot;,
+    &quot;Python.PDFtranslater (1).executor&quot;: &quot;Run&quot;,
+    &quot;Python.PDFtranslater (2).executor&quot;: &quot;Run&quot;,
+    &quot;Python.agent_utils.executor&quot;: &quot;Run&quot;,
+    &quot;Python.convert.executor&quot;: &quot;Run&quot;,
+    &quot;Python.markdown_splitter.executor&quot;: &quot;Run&quot;,
+    &quot;Python.markdown_utils.executor&quot;: &quot;Run&quot;,
+    &quot;Python.test.executor&quot;: &quot;Run&quot;,
+    &quot;Python.test1.executor&quot;: &quot;Run&quot;,
+    &quot;Python.translater.executor&quot;: &quot;Debug&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
+    &quot;last_opened_file_path&quot;: &quot;C:/Users/jxgm/Desktop/FileTranslate/tests/resource&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.detected.package.tslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;node.js.selected.package.tslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;Errors&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
   }
-}]]></component>
+}</component>
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
       <recent name="C:\Users\jxgm\Desktop\FileTranslate\tests\resource" />
@@ -303,7 +304,8 @@
       <workItem from="1746593417117" duration="25924000" />
       <workItem from="1746626070703" duration="7931000" />
       <workItem from="1746669839816" duration="20657000" />
-      <workItem from="1746693297445" duration="704000" />
+      <workItem from="1746693297445" duration="915000" />
+      <workItem from="1746694671369" duration="1036000" />
     </task>
     <servers />
   </component>
@@ -313,7 +315,7 @@
   <component name="com.intellij.coverage.CoverageDataManagerImpl">
     <SUITE FILE_PATH="coverage/filetranslate$test.coverage" NAME="test 覆盖结果" MODIFIED="1746677277745" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests" />
     <SUITE FILE_PATH="coverage/PDFtranslate$translater.coverage" NAME="translater 覆盖结果" MODIFIED="1746600434803" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/pdftranslate_packages" />
-    <SUITE FILE_PATH="coverage/filetranslate$test1.coverage" NAME="test1 覆盖结果" MODIFIED="1746693838593" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests" />
+    <SUITE FILE_PATH="coverage/filetranslate$test1.coverage" NAME="test1 覆盖结果" MODIFIED="1746694693445" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/tests" />
     <SUITE FILE_PATH="coverage/PDFtranslate$PDFtranslater__1_.coverage" NAME="PDFtranslater (1) 覆盖结果" MODIFIED="1746633258205" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/pdftranslate_packages" />
     <SUITE FILE_PATH="coverage/PDFtranslate$convert.coverage" NAME="convert 覆盖结果" MODIFIED="1746596984213" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/pdftranslate_packages/utils" />
     <SUITE FILE_PATH="coverage/PDFtranslate$agent_utils.coverage" NAME="agent_utils 覆盖结果" MODIFIED="1746617703678" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="false" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/pdftranslate_packages/utils" />
diff --git a/README.md b/README.md
index bf46346..ff161da 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
 常见的大模型平台baseurl可见[常用baseurl](#常用baseurl)
 
 # 使用方式
-## 使用默认参数翻译pdf
+## 翻译文件
 
 ```python
 from docutranslate.translater import FileTranslater
@@ -31,6 +31,9 @@ translater.translate_pdf_file("<pdf路径>", to_lang="中文")
 
 # 开启公式、代码识别（需要下载更多模型）
 translater.translate_pdf_file("<pdf路径>", to_lang="中文",formula=True, code=True)
+
+#翻译markdown文件
+translater.translate_markdown_file("<markdown路径>",to_lang="中文")
 ```
 > 第一次使用时需要下载模型（约1G、使用公式、代码识别需要多约0.5G），请稍作等待  
 > 输出文件默认放在`./output`中
@@ -48,6 +51,17 @@ translate_agent = translater.create_translate_agent(baseurl="<baseurl-2>", key="
 translater.translate_pdf_file(pdf_path="<pdf路径>", to_lang="中文", refine_agent=refine_agent,
                               translate_agent=translate_agent)
 ```
+## 文件转换(pdf/markdown->markdown/html)
+```python
+from docutranslate import FileTranslater
+translater=FileTranslater(base_url="<baseurl>", 
+               key="<key>", 
+               model_id="<model-id>")
+#markdown转html
+translater.read_markdown("<markdown路径>").save_as_html()
+#pdf转markdown
+translater.read_pdf_as_markdown("<pdf路径>").save_as_markdown()
+```
 
 ## 参数说明
 ### 创建FileTranslate
diff --git a/docutranslate/translater.py b/docutranslate/translater.py
index 5e7d2cc..f25c739 100644
--- a/docutranslate/translater.py
+++ b/docutranslate/translater.py
@@ -97,10 +97,12 @@ hello<ph-aaaaaa>, what's your name?
 你好<ph-aaaaaa>，你叫什么名字？\no_think""".format(to_lang)
         return agent
 
-    def read_pdf_as_markdown(self, pdf: Path | None = None, formula=False, code=False, save=False):
+    def read_pdf_as_markdown(self, pdf: Path |str|None = None, formula=False, code=False, save=False):
         print("正在将pdf转换为markdown")
         if pdf is None:
             pdf = self.file_path
+        if isinstance(pdf,str):
+            pdf=Path(pdf)
         self.markdown = pdf2markdown_embed_images(pdf, formula, code)
         print("pdf已转换")
         if save: