dynamicdevs/docfx-ts repository overview

⁠Docker Image - DocFx for Typescript

DocFx is a Document generator for Typescript projects

• For Use documentation refer to DocFx Official Site⁠.

⁠Instructions

You can build your document code with the following command:

docker run --rm --name docfx \
-v path-to-docs-folder:/docfx \
-v path-to-src-if-apply:/app \
    dynamicdevs/docfx-ts:latest

⁠Important

• You must include in the app directory the node_modules directory
• your source code mus be on src directory into app directory in the container
• You should map document directory into /docfx directory.
• docfx.json and node2docfx.json files should be in the same directory
• Whether your src folder is into directory /docfx folder don't map the src volume

⁠Plugins

• Plugins memberpage, rest.operationpage, rest.tagpage are in this image on the /docfx/plugins directory