selfdoc v0.37.1 /selfdoc init

Reference for the selfdoc init command — usage, flags, arguments, and examples for the init subcommand of the selfdoc CLI.

#selfdoc init

Initialize selfdoc configuration and starter docs template

Effect: mutating

#Flags

Flags
NameShortTypeDefaultEnvDescription
--base-urlstrBase URL the generated site will be served from (e.g. 'https://docs.example.com'). Required: it is the site's own address, which selfdoc cannot infer, and every canonical link, sitemap entry and feed URL is built from it
--auto-commitboolTrueAutomatically commit the generated selfdoc.json and docs/index.md template files to git
Search