Skip to content

README.md

Latest commit

 

History

History
39 lines (25 loc) · 893 Bytes

README.md

File metadata and controls

39 lines (25 loc) · 893 Bytes

markdocs

A command line tool for MarkDocs.

Install

Execute command:

dotnet tool install -g ITGlobal.MarkDocs.CommandLineTool

Then run:

markdocs [command]

Update

If markdocs CLI tool is already installed, type the following command to update it:

dotnet tool update -g ITGlobal.MarkDocs.CommandLineTool

Commands

  • markdocs lint - runs a linter over a directory
  • markdocs build - generates a static HTML website from a directory
  • markdocs serve - serves a website from a directory (updating on the fly!)
  • markdocs serve-git - serves a website from a git repository (updating on the fly!)

Try markdocs --help or markdocs <command> --help to find out more.

Docker image

Commands markdocs serve and markdocs serve-git are also available as a Dockerized application.