Sign inSign up

pheese/cmd-docfx

By pheese

•Updated almost 2 years ago

DocFx can produce documentation from source code.

Image
0

167

pheese/cmd-docfx repository overview

⁠DocFx Container

Official Web page DocFX can be found here⁠ .

Generate static sites from Markdown and code files

DocFX⁠ can produce documentation from source code (including C#, F#, Visual Basic, REST, JavaScript, Java, Python and TypeScript) as well as raw Markdown files.

Easily customize the output

DocFX⁠ provides a flexible way to customize templates and themes.

⁠Version

⁠Sources Container

⁠Generate and run a DocFX website locally in a docker container

  1. Fork & then clone the git repository DocFx sample web⁠ on your computer.

  2. Run the docker container.

   # amd64:
   docker run -it --rm --name docfx -p 8080:80 -v {DocFX website folder}:/source docker.io/pheese/cmd-docfx:amd64

   # arm64:
   docker run -it --rm --name docfx -p 8080:80 -v {DocFX website folder}:/source docker.io/pheese/cmd-docfx:arm64
  1. Execute in the container
   # Start nginx server
   nginx
   sleep 5

   # Compile DocFX Site
   docfx docfx.json

   # Host web site on port 8080
   docfx serve /source/_site
  1. Go into your browser and access http://localhost:8080⁠

Tag summary

Content type

Image

Digest

sha256:c3d93b2e9…

Size

916.6 MB

Last updated

almost 2 years ago

docker pull pheese/cmd-docfx:amd64