jakubandrysek/mkdocs-typedoc

📇 The Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.

Jakub Andrysek

Hi, I'm Jakub Andrýsek, but almost everyone calls me Kuba.

I am a university computer science student from the Czech Republic passionate about programming, electronics, 3D modelling and robotics.

I aim to build innovative tools and products that make developers' lives easier and more productive. I'm also a big fan of open-source software and hardware.

Most of my projects are open-source; you can find them on my GitHub profile.

Github Stats

My projects

📑 MkDoxy - MkDocs + Doxygen (easy documentation generator)

Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.

• Website
• GitHub

🎮 PySpaceMouse - Python library for 3Dconnexion SpaceMouse

3Dconnexion Space Navigator in Python using raw HID (multi platform)

• Website
• GitHub

🧦 Pletačka IoT (iSocks IoT) - IoT system for monitoring industrial production

iSocks IoT is a system for automatic monitoring of industrial production and its implementation in practice.

• GitHub
• Post on my blog (CZ)
• About me on the internet (CZ)

🔌 More MkDocs plugins

• ✂️ mkdocs-resize-images - MkDocs plugin to resize images according to the configuration
• 🔮 mkdocs-open-in-new-tab - This plugin adds JS to open outgoing links and PDFs in a new tab.
• 📇 mkdocs-typedoc - Mkdocs plugin to generate documentation from TypeScript files using TypeDoc.
• 📂 mkdocs-zip-folders - MkDocs plugin to zip configured folders and add them to the site.

➕ More projects

mkdocs-typedoc's Issues

Windows uses npx.cmd

Hi! I was taking a look at mkdocs-typedoc and found the Windows problem. I checked my local node executables and found that npx is called npx.cmd on Windows:

Looks like the solution is to just call npx.cmd on Windows and npx on all other platforms:

Python 3.11.5 (tags/v3.11.5:cce6ba9, Aug 24 2023, 14:38:34) [MSC v.1936 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import subprocess
>>> result = subprocess.run(["npx.cmd", "typedoc", "--version"], check=True, capture_output=True, text=True)
>>> result.returncode
0