Skip to content

Commit 1329c21

Browse files
committed
Some copy updates and improved nav bar.
1 parent 3e99ccd commit 1329c21

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

docs/faq/index.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ FAQ
3333
--blue: #60a5fa;
3434
--red: #f87171;
3535
--purple: #c084fc;
36+
--bgTransparent: rgba(15,17,23,0.95);
3637
}
3738
3839
body[data-theme="light"] {
@@ -49,6 +50,7 @@ FAQ
4950
--blue: #2563eb;
5051
--red: #dc2626;
5152
--purple: #9333ea;
53+
--bgTransparent: rgba(255, 255, 255, 0.95);
5254
}
5355
5456
.toc-drawer {
@@ -67,6 +69,9 @@ FAQ
6769
#nav {
6870
position: sticky;
6971
top: 0;
72+
background: var(--bgTransparent);
73+
padding-bottom: 12px;
74+
border-bottom: 1px solid var(--border);
7075
}
7176
7277
* { margin: 0; padding: 0; box-sizing: border-box; }
@@ -352,7 +357,7 @@ FAQ
352357
<pre><code>pip install pymupdf</code></pre>
353358
<p>Second, verify your IDE (PyCharm, VS Code, etc.) is using the same Python interpreter and virtual environment where you installed it. Try running <code>python -c "import pymupdf; print(pymupdf.__doc__)"</code> directly in a terminal to isolate IDE issues.</p>
354359
<p>Third, there is a separate PyPI package literally named <code>fitz</code> that has nothing to do with PyMuPDF. These two packages cannot coexist in the same environment. If you installed both, uninstall <code>fitz</code> and reinstall <code>pymupdf</code>.</p>
355-
<div class="tip"><strong>Note:</strong> Starting from version 1.24.0, you can also use <code>import pymupdf</code> as an alternative to <code>import fitz</code>.</div>
360+
<div class="tip"><strong>Note:</strong><code>import fitz</code> still works as a legacy alias, but <code>import pymupdf</code> is the recommended import since version 1.24.0.</div>
356361

357362
</div>
358363
</div>
@@ -402,7 +407,7 @@ FAQ
402407
<p><code>"dict"</code> — Structured dictionary with blocks, lines, and spans including font information. Use this when you need font names, sizes, and colors.</p>
403408
<p><code>"rawdict"</code> — Like "dict" but with individual character-level positions. The most detailed but largest output. Use when you need exact character placement.</p>
404409
<p><code>"json"</code> / <code>"rawjson"</code> — Same as dict/rawdict but as JSON strings. Easier to save to a file for inspection.</p>
405-
<div class="tip"><strong>Harald's advice:</strong> If you want to inspect the output structure, use <code>"json"</code> or <code>"rawjson"</code> and save to a file rather than trying to dump a deeply nested dict to CSV.</div>
410+
<div class="tip"><strong>Tip:</strong> If you want to inspect the output structure, use <code>"json"</code> or <code>"rawjson"</code> and save to a file rather than trying to dump a deeply nested dict to CSV.</div>
406411
</div>
407412
</div>
408413

@@ -465,7 +470,7 @@ FAQ
465470
for rect in areas:
466471
print(rect) # pymupdf.Rect with coordinates</code></pre>
467472
<p>This returns a list of <code>Rect</code> objects showing where each occurrence appears. Note: regular expressions are not supported. If you need regex matching, first extract the full text with <code>get_text()</code>, find matches, then use <code>search_for()</code> to locate each match on the page.</p>
468-
<div class="tip"><strong>Performance:</strong> Adding <code>quads=True</code> is actually slightly faster than the default, because rects are internally converted from quads.</div>
473+
<div class="tip"><strong>Performance note:</strong> Adding <code>quads=True</code> is actually slightly faster than the default, because rects are internally converted from quads.</div>
469474
</div>
470475
</div>
471476

@@ -603,7 +608,6 @@ FAQ
603608
<div class="faq-q"><span class="marker">Q</span><span class="question">Does PyMuPDF4LLM send my data to any external service or API?</span><span class="toggle">+</span></div>
604609
<div class="faq-a">
605610
<p><strong>No.</strong> PyMuPDF4LLM is completely derived from PyMuPDF. There is no access to anything beyond your local machine. No calls to any AI, LLM, RAG, or cloud service. Everything works exactly the same when all internet access is blocked. It is fully GDPR-compatible in terms of data processing.</p>
606-
<p class="source">This is the most frequently asked question about PyMuPDF4LLM on Discord.</p>
607611
</div>
608612
</div>
609613

@@ -817,9 +821,9 @@ FAQ
817821
</div>
818822

819823
<div class="faq">
820-
<div class="faq-q"><span class="marker">Q</span><span class="question">Does MuPDF support "cloudy" border style for annotations?</span><span class="toggle">+</span></div>
824+
<div class="faq-q"><span class="marker">Q</span><span class="question">Does PyMuPDF support "cloudy" border style for annotations?</span><span class="toggle">+</span></div>
821825
<div class="faq-a">
822-
<p>No. MuPDF only supports plain borders at the moment. The cloudy border effect (common in Adobe PDF annotations) is not implemented in MuPDF's C core, so it's not available through PyMuPDF either.</p>
826+
<p>No. The cloudy border effect (common in Adobe PDF annotations) is not implemented in MuPDF's C core, so it's not available through PyMuPDF either.</p>
823827
</div>
824828
</div>
825829

0 commit comments

Comments
 (0)