How to set Default Custom Homepage in Theia IDE

DilLip_Chowdary · 5 February 2021 10:13

Hey Team theia-ide,

I Have a doubt , How to set custom built Page (Kind of README or HTML ) as home screen or default page in Theia IDE

vince-fugnitto · 5 February 2021 13:26

@DilLip_Chowdary thank you for the question, you will need to implement your own custom theia extension (https://theia-ide.org/docs/authoring_extensions/) which contributes the functionality. The goal would be to once the application starts (and a workspace is present) you load the readme file (or any file you want) and open it in an editor or preview. You can inspire yourself on how the getting-started view loads on startup (although it’s conditions are different than yours as it opens when no workspace is present):

github.com

eclipse-theia/theia/blob/bd25d737742a0974b911da5d3a5c978d950fc64e/packages/getting-started/src/browser/getting-started-contribution.ts#L51-L57


async onStart(app: FrontendApplication): Promise<void> {
    if (!this.workspaceService.opened) {
        this.stateService.reachedState('ready').then(
            () => this.openView({ reveal: true })
        );
    }
}

I believe that gitpod (one of the many applications built with the theia framework) opens the readme when the application first starts, you may like to view their sources or reference them if you get stuck:

https://github.com/gitpod-io/gitpod/blob/9ad74422c168d1e17da756efdc23aa010f96d0f1/components/theia/packages/gitpod-extension/src/browser/gitpod-open-context.ts#L107-L148