Skip to content

Commit 652482d

Browse files
committed
Add a brief summary of how mike interacts with git; resolves #53
1 parent 1298b89 commit 652482d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ While mike is flexible, it's optimized around putting your docs in a
2222
particularly notable versions. This makes it easy to make permalinks to whatever
2323
version of the documentation you want to direct people to.
2424

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+
2533
## Installation
2634

2735
Like most Python projects, mike uses [setuptools][setuptools], so installation

0 commit comments

Comments
 (0)