Doctave / doctave

A batteries-included developer documentation site generator
https://cli.doctave.com
MIT License
565 stars 32 forks source link

Distorted Format after building the site #45

Closed RenukaMane closed 2 years ago

RenukaMane commented 2 years ago

Hello

I am tried to build a documentation site with the examples.md page as well as a few new pages added to it. However after building the site in release mode the contents of the html pages are distorted also the diagrams drawn with mermaidJS are not visible. Can you help me out with this issue.

Screenshot (21)

begleynk commented 2 years ago

The generated site requires a webserver to be rendered - just opening the .html files won't work as the CSS and Javascript won't be loaded.

This is why the tool has the doctave serve command. It will start a web server locally for you and you can then view the site in your browser in the address http://localhost:4001.

There's a tutorial here in the tool's docs that walks through the steps: https://cli.doctave.com/tutorial