armeria icon indicating copy to clipboard operation
armeria copied to clipboard

Allow customizing the title of the documentation service

Open ikhoon opened this issue 1 year ago • 6 comments

The title of the documentation service is hard-coded to Armeria documentation service <version> https://github.com/line/armeria/blob/e0192ccbaa01f9c6f03849d4879507d93dc17aa8/docs-client/src/containers/App/index.tsx#L608-L611

Some users may want to override the title to easily distinguish a server from a different phase or role.

DocService
  .builder()
  .webAppTitle("Messaging (Alpha)")
  ...
  .build()

The specified web app title could be appended to the default title.

Armeria documentation service 1.30.1 - Messaging (Alpha)

ikhoon avatar Sep 10 '24 08:09 ikhoon

Hi @ikhoon , I would like to contribute to this issue. Can you please assign it to me??

dipeshsingh253 avatar Oct 01 '24 14:10 dipeshsingh253

I've assigned https://github.com/line/armeria/issues/5219 to you. Do you want to resolve both of them at once?

ikhoon avatar Oct 10 '24 09:10 ikhoon

Yeah, I can do that. This seems a good first issue as well.

dipeshsingh253 avatar Oct 11 '24 14:10 dipeshsingh253

Hi, it seems the resolution is stuck. I could take it on if possible.

Ivan-Montes avatar Mar 24 '25 11:03 Ivan-Montes

Hi, how about to change not only title in the top of the page but title element in the <head> of the html? Also Messaging (Alpha) - Armeria documentation service 1.30.1 might be more convenient when you have several tabs open and whole page title is not displayed:

Image

Ideally it would be great to change the favicon and the background color of the Header bar e.g. to have different colors for different deployment environments.

All of that is possible now with the custom JS scripts (which find and modify elements by id/class) we can inject to the Doc Service page but since html structure can be changed with new releases it is better to be able to do it with the official API.

Thank you!

AnyRoad avatar Mar 29 '25 02:03 AnyRoad

Agreed. All of your ideas look nice to me.

ikhoon avatar Mar 31 '25 13:03 ikhoon