HTML Output Customization

Started by zkhanz, April 09, 2025, 12:30:43 PM

Previous topic - Next topic

zkhanz

Hi
I need all views from my models to publish on my internal portal. The user click on the view and it goes to the respective view. I am not a Web developer, but if someone can help, I can hire a developer to develop this custom portal for EA from my work. Thanks Zubair

Xiaoqi

Hi zkhanz,

My practices in our company's EA repository, is using Next.js to code a web-app, export your Archi model as HTML Report into the static pages folder (In Next.js it's ./public/html folder), then deploy your app to either an on-prem web-server or cloud webapp.

It should be also fine for using any other kind of the web server for developing your base site, just give proper link to the index.html file of your HTML Exported Report.

Good luck,
Xiaoqi

zkhanz

Quote from: Xiaoqi on April 10, 2025, 05:32:12 AMHi zkhanz,

My practices in our company's EA repository, is using Next.js to code a web-app, export your Archi model as HTML Report into the static pages folder (In Next.js it's ./public/html folder), then deploy your app to either an on-prem web-server or cloud webapp.

It should be also fine for using any other kind of the web server for developing your base site, just give proper link to the index.html file of your HTML Exported Report.

Good luck,
Xiaoqi
Thanks Xiaoqi for the advice, I will try it.

Alberto

To publish to HTML, there are three options, each with pros and cons:

Archi's built-in HTML Report (Page 108 of the User Guide).  Pros: Is built-in. Has AlaSQL integrated. Cons: It uses scripts, which some CMS like SharePoint might not like (see ASPX workaround here). The bigger the model, the more files it generates. Make sure to whitelist them in your AntiVirus as it is known that they might have an adverse effect when syncing or publishing to GIT.

Single-Page HTML by our own JB Sarrodie.  Pros: Single page HTML.  No scripts. Supports MarkDown in Documentation field. Cons: Does not support navigation within Views (one of your requirements). Note: Requires jArchi which you can get when you become an Archi supporter on Patreon.

Similar to above, there's View2SingleHTML by Remco Schellekens.  It exports one View at a time and uses SVG rather than PNG, which scales better within the browser. Also requires jArchi.

I'll be adding these and more to the Best Practices thread soon.