How Can I use Mkdocs on local computer without server?

Question

I installed Mkdocs (Python 3.6.5) and edited and built Markdown files.

I tried to open the main index.html file with a browser, but I cannot directly open HTML pages linked to other HTML files.

Using Command Prompt and typing "mkdocs serve", I can open linked pages. I know this is a normal function of Mkdocs without server.

Can I use Mkdocs just on my local computer?

score 5 · Answer 1 · answered Aug 13 '18 at 06:41

According to the doc, you can add use_directory_urls: false in mkdocs.yml and rebuild it.

The default style of use_directory_urls: true creates more user friendly URLs, and is usually what you'll want to use. The alternate style (edit: use_directory_urls: false) can occasionally be useful if you want your documentation to remain properly linked when opening pages directly from the file system, because it creates links that point directly to the target file rather than the target directory.

Great. Don't forget to accept the answer to help others with similar problem — Yohanes Gultom, Aug 13 '18 at 07:06

score 0 · Answer 2 · answered Sep 03 '18 at 19:02

0

According to official documentation you can generate html files with mkdocs build. They will be stored in folder called site. You can open built files without having to run mkdocs serve.

answered Sep 03 '18 at 19:02

SloCompTech

116
1
7

How Can I use Mkdocs on local computer without server?

2 Answers2