We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 1298b89 commit 652482dCopy full SHA for 652482d
README.md
@@ -22,6 +22,14 @@ While mike is flexible, it's optimized around putting your docs in a
22
particularly notable versions. This makes it easy to make permalinks to whatever
23
version of the documentation you want to direct people to.
24
25
+## How it works
26
+
27
+mike works by creating a new Git commit on your `gh-pages` branch every time you
28
+deploy a new version of your docs using `mike deploy` (or other mike subcommands
29
+that change your `gh-pages` branch). When deploying a particular version,
30
+previously-deployed docs for that version are erased and overwritten, but docs
31
+for other versions remain untouched.
32
33
## Installation
34
35
Like most Python projects, mike uses [setuptools][setuptools], so installation
0 commit comments