logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

dh_mkdocs - helps with packaging MkDocs-generated documentation

Author

       Dmitry Shachnev <mitya57@debian.org>

                                                   2025-03-16                                       DH_MKDOCS(1)

Description

dh_mkdocs is a helper program for packaging documentation generated by MkDocs. More specifically:

       •   It  replaces  static  files with symlinks to their packaged versions if possible.  For packages using
           non-standard themes, use the --theme-package option, for example:

               dh_mkdocs --theme-package mkdocs-bootstrap

           dh_mkdocs only symlinks non-empty files with identical content.

       •   For the standard mkdocs and readthedocs themes, it replaces references to  the  highlight.js  library
           from CDN with references to the packaged version of that library.

       •   It adds the needed dependencies to ${mkdocs:Depends} substitution variable.  Please add this variable
           to the Depends: field of your documentation package.

       You can pass --withmkdocs to dh(1) to make it automatically call dh_mkdocs after dh_installdocs.

Name

       dh_mkdocs - helps with packaging MkDocs-generated documentation

Options

-Xitem, --excludeitem
           Exclude files that contain item anywhere in their filename from being symlinked or edited.

           This option can be specified multiple times.

       -Tpackage, --theme-packagepackage
           Scan the specified additional package for files that can be used as symlink targets.

           This option can be specified multiple times.

See Also

debhelper(7), dh(1).

       This program is meant to be used together with debhelper.

Synopsis

       dh_mkdocs [debhelperoptions] [-Xitem] [-Tpackage | --theme-packagepackage]

See Also