![](/img/trans.png)
[英]Mkdocs unable to find modules
我正在嘗試生成自動文檔,使用: mkdocs = "^1.4.2" mkdocstrings = "0.19.0" mkdocs-material = "8.5.8" mkdocstrings-python = "0.7.1" 我的 mkdocs.yml 看起來像這樣: index.md 仍然是 ...
[英]Mkdocs unable to find modules
我正在嘗試生成自動文檔,使用: mkdocs = "^1.4.2" mkdocstrings = "0.19.0" mkdocs-material = "8.5.8" mkdocstrings-python = "0.7.1" 我的 mkdocs.yml 看起來像這樣: index.md 仍然是 ...
[英]Including extra.css with mkdocs
mkdocs 的文檔描述了一種方法來包含一些額外的 css 定制,而無需像使用 custom_theme 目錄那樣覆蓋整個文件。 考慮以下示例: mkdocs.yml :site_name: MWE nav: - 'Home': index.md theme: name: mkdocs ...
[英]`mkdocstrings-python-legacy` Produces `AttributeError` Using `mkdocs serve`
我正在使用mkdocs 、 mkdocs-smae-dir 、 mkdocs-simple 、 mkdocstrings和mkdocstrings-python-legacy記錄一個小的 package 。 當我嘗試使用mkdocs-serve查看我的文檔時,它會產生以下屬性錯誤,Attribut ...
[英]Github Actions Mkdocs and Docker containers ? not playing nicely
我無法讓 mkdocs 在提交時由 GitHub 操作運行的容器中工作。 大家好, 我一直在嘗試在 GitHub 上獲取我的 python 代碼文檔。我已經設法通過運行 GitHub 操作來做到這一點 使用以下 GitHub 操作流程: 問題是 mkdocstrings 不起作用,因此網頁上沒有顯示 ...
[英]How to highlight code block with material mkdocs package?
我正在使用材料 mkdocs package,我想突出顯示 JSON 代碼塊的第 7-31 行,但我不確定該怎么做。 我已經查看了文檔並嘗試了一段時間,但沒有任何方法可以解決我的問題。 有誰知道如何解決這個簡單的問題? ...
[英]Render markdown files contain mermaid diagrams to a combined PDF file using mkdocs
目前,我正在使用mkdocs-material來使用美人魚圖,配置如下(在mkdocs.yml中):... markdown_extensions: - pymdownx.superfences: custom_fences: - name: mermaid cl ...
[英]How can I toggle between Windows and Mac commands on MKDocs?
我正在為我的用戶使用material mkdocs作為我的外部文檔。 我想知道如何在文檔中實現在不同操作系統命令之間切換的效果? 我從Django Docs tutorial得到了這張截圖 ...
[英]MKDocs Can't make document
我將使用MKDocs來制作文檔,但它說: 我已經在2022年10月23日的Commits中推送了github commit e8221fc1f0402834b6db92280e67e9fcac4a2b10中的內容,我該如何完成呢? 為什么失敗了? PS 這是/home/phao/桌面/python ...
[英]Backstage Unable to use mkdocs to create Tech Docs for an existing component
我已啟用 Github 操作以在提交后創建技術文檔。 下面是為創建 Md 文件而編寫的工作流文件。 但是“techdocs-cli generate --no-docker --verbose”命令失敗並出現以下錯誤。 有人可以幫忙解決這個問題嗎? 無法從 /home/runner/work/mya ...
[英]MkDocs, mkdocstrings - attach only module docstring
當我想在我的文檔中附加bar模塊的文檔字符串時,我把::: foo.bar 在 markdown 文件中。 它附加了bar文件中的所有文檔字符串 - 模塊文檔字符串和Bar class 文檔字符串。 當我只想附加Bar類文檔字符串時,語法是: ::: foo.bar.Bar 現在我只想引用沒有 cl ...
[英]Links work in MkDocs but not on GitHub repo
我正在嘗試在我的 MkDocs 網頁上放置這樣的圖像: 哪個工作正常。 但是,當我將其上傳到 GitHub 時,圖像不顯示。 有沒有辦法更改鏈接,以便它們在 GitHub 和 MkDocs 網頁上工作? 謝謝! ...
[英]Can I style rendered markdown tables in mkdocs (supply table with class / id)
使用 mkdocs,我轉換了一些包含技術信息的 markdown 表。 我想用 css 為這些表格設置樣式 - 但不是網站上的每個表格。 我的目標是為某些表設置一個 id 或 class 。 我原來的markdown(例子) 使用“材料”主題生成 html。 使用主題中的 javascript 插 ...
[英]MkDocs - How to include directory names in automatic generation of nav
我正在嘗試使用 mkdocs 來自動生成導航。 nav 是按文件名的字母數字順序自動生成的。 但是,當其中有目錄時,它就不能正常工作。 有沒有更好的辦法? 文件樹 結果 期望的結果 ...
[英]Different images for light/dark mode with Material for MkDocs
我正在使用MkDocs和Material for MkDocs編寫文檔。 我想在index.md中有一個圖像,當我從淺色模式切換到深色模式時,它可以在兩個不同的版本之間切換,反之亦然。 我在網上找到了不同的解決方案,但它們似乎都不起作用。<picture> <source ...
[英]Deploying Mkdocs to Azure web apps
似乎無法將Mkdocs(材料)站點部署到 Azure Web 應用程序。 我們為我們的抵押品和文檔建立了一個Mkdocs 站點,我曾多次嘗試使用Azure(網絡應用程序、static 應用程序和 DevOps)來托管它,但似乎沒有任何效果。 最好不要使用Git 頁面或第 3 方托管應用程序下面是我的 ...
[英]Backstage: How to modify the docs theme and colors (MKDocs)
我想在后台應用程序(而不是每個 Docs 文件夾中)的全局級別更改 techdocs 主題及其 colors。 我怎樣才能做到這一點? 示例:更改所有代碼片段的背景顏色。 ...
[英]Permission denied to github-actions[bot]
我正在使用 mkdocs 為我的項目生成文檔,現在我無法將這些文檔部署到 Github 頁,它告訴我: 遠程:XXX.git 的權限被 github-actions[bot] 拒絕。 致命:無法訪問“XXX”:請求的 URL 返回錯誤:403 這是我的CI配置。 還有我的存儲庫秘密:(這兩個GIT_ ...
[英]Cannot create docs for components in backstage docker error
我正在嘗試在 backstage-io /docs 頁面 UI 上顯示存儲在由后台 io 組件創建的存儲庫中的文檔,但是當我嘗試訪問文檔時出現以下錯誤 我的存儲庫中的文件 docs 文件夾只有 index.md 和 mkdocs.yml 有 ...
[英]Document versioning in monorepo
背景:我有一個包含多個子目錄的倉庫。 例如 每個子目錄在 Github 中都有自己的版本標簽。 例如 Foo v1.0.0 Bar v2.0.0 我目前正在為我開始使用 Mkdocs 研究的每個子目錄探索一個單獨的版本控制文檔,並將該文檔托管在 Github Pages 中。 雖然我可以使用 ...
[英]mkdocstrings: ERROR - Error reading page 'codereference.md': <class '_ast.ExtSlice'>
在終端中鍵入 mkdocs serve 時出現以下錯誤: 錯誤 - 讀取頁面 'codereference.md' 時出錯:<class '_ast.ExtSlice'>(有很長的回溯,見下文) 我的 mkdocs.yaml 文件是: codereference.md 文件包含 ...