otty / apps
All apps/MkDocs

MkDocs

mkdocs

Project documentation with Markdown.

Runs as mkdocs|macOS, Linux, Windows|www.mkdocs.org
Open form in Otty otty.toml

Command form

ai-draft · 3 tasks · 10 fields

Start a project, preview it locally or build the static site. Deployment to GitHub Pages is left out.

Opens the form; the finished command lands at your prompt, unrun
Run in Otty
otty gui mkdocs

mkdocs new

Create a new project
Create a new projectExample values, fixed in this page — nothing here reaches a terminal
Basic
Project directory*
directory
TasksEach one presets the form for one job
New project
dir
ParametersOnly these flags are editable in the form
Project directory
path · positional 0

mkdocs serve

Preview locally
Preview locallyExample values, fixed in this page — nothing here reaches a terminal
Basic
Address
string
Config file
file
Strict mode
--strict
TasksEach one presets the form for one job
Serve
dev_addrconfig_filestrict
ParametersOnly these flags are editable in the form
Address
IP:PORT, default localhost:8000.
string
--dev-addr-a
Config file
path
--config-file-f
Strict mode
boolean
--strict-s
Disable live reload
boolean
--no-reload

mkdocs build

Build the site
Build the siteExample values, fixed in this page — nothing here reaches a terminal
Basic
Config file
file
Output directory
directory
Strict mode
--strict
Clean old files first
--clean
TasksEach one presets the form for one job
Strict build
config_filesite_dirstrictclean
ParametersOnly these flags are editable in the form
Config file
path
--config-file-f
Output directory
path
--site-dir-d
Strict mode
Abort the build on any warning.
boolean
--strict-s
Clean old files first
boolean
--clean-c
Theme
string
--theme-t
SourcesEvery flag above is checked against these
fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

Before it fills your prompt, Otty checks the installed mkdocs against its version. A form that does not match your version is not offered.