jimporter / mike

Manage multiple versions of your MkDocs-powered documentation via Git
BSD 3-Clause "New" or "Revised" License
536 stars 47 forks source link

How to get started? README.md doesn't help. #53

Closed samthesuperhero closed 3 years ago

samthesuperhero commented 3 years ago

Dear Contributors,

I use:

All is OK with mkdocs and mkdocs-material - everything is built and running both on local (with mkdocs serve) and on my web server - site by URL is fully functional!

And with mike:

  1. I made git init in the source dir with my mkdocs material sources
  2. Then, did add and commit
  3. Then, run mike deploy 0.1 dev and mike deploy 0.2 new
  4. I see that in my site_dir directory there are rendered web files
  5. I deploy that web files to my web server,
  6. I don't see the version selector
  7. Then locally I do mike serve
  8. Locally at http://localhost:8000 I see that version selector appears!!

What do I do wrong?

Why there are no explanations about such cases in README.md for those like me who are out of context?

jimporter commented 3 years ago

You need to serve the contents of your gh-pages branch. The site directory is just a temporary staging location for the generated docs.

samthesuperhero commented 3 years ago

Works, super, thx!! Maybe worth adding to docs for newcomers ;)