Open readme file in preview mode on editor launch

[yogaprabu]

I have a readme file in my directory which I want to open in preview mode when the editor launches. We need to set a similar configuration in my Theia editor as shown in the screenshot

[msujew]

Are you asking how to change the preference's default to readme? You can control the default preferences via the cli, see here.

[vince-fugnitto]

In addition to what Mark mentioned, the workbench.startupEditor preference has been implemented as of v1.41.0 (704996d):

theia/packages/getting-started/src/browser/getting-started-preferences.ts

Lines 31 to 33 in 03d0cb8

	'workbench.startupEditor': {
	type: 'string',
	enum: ['none', 'welcomePage', 'readme', 'newUntitledFile', 'welcomePageInEmptyWorkbench'],

[yogaprabu]

Hi @msujew and @vince-fugnitto, I am trying to set the preference as shown in the below package.json file but there is no success. Can you please help me in rectifying the approach I'm taking?

{
  "private": true,
  "theia": {
    "frontend": {
      "config": {
        "warnOnPotentiallyInsecureHostPattern": true,
        "applicationName": "My App",
        "preferences": {
          "files.enableTrash": false,
          "files.defaultLanguage": "markdown",
          "workbench.startupEditor": "readme"
        }
      }
    }
  },
  "dependencies": {
    "@theia/callhierarchy": "1.41.0",
    "@theia/file-search": "1.41.0",
    "@theia/git": "1.41.0",
    "@theia/markers": "1.41.0",
    "@theia/messages": "1.41.0",
    "@theia/navigator": "1.41.0",
    "@theia/outline-view": "1.41.0",
    "@theia/core": "1.41.0",
    "@theia/plugin": "1.41.0",
    "@theia/plugin-dev": "1.41.0",
    "@theia/plugin-ext": "1.41.0",
    "@theia/plugin-metrics": "1.41.0",
    "@theia/plugin-ext-vscode": "1.41.0",
    "@theia/preferences": "1.41.0",
    "@theia/preview": "1.41.0",
    "@theia/search-in-workspace": "1.41.0",
    "@theia/terminal": "1.41.0",
    "@theia/vsx-registry": "1.41.0"
  },
  "devDependencies": {
    "@theia/cli": "1.41.0",
    "http-proxy-agent": "^7.0.0",
    "https-proxy-agent": "^7.0.1",
    "socks-proxy-agent": "^8.0.1"
  },
  "optionalDependencies": {
    "@vscode/windows-ca-certs": "^0.3.1"
  },
  "scripts": {
    "prepare": "yarn run clean && yarn build && yarn run download:plugins",
    "clean": "theia clean",
    "build": "theia build --mode development",
    "start": "theia start --plugins=local-dir:plugins",
    "download:plugins": "theia download:plugins"
  },
  "workspaces": [
    "applications/*",
    "theia-extensions/*"
  ],
  "theiaPluginsDir": "plugins",
  "theiaPlugins": {
    "vscode-builtin-extensions-pack": "https://open-vsx.org/api/eclipse-theia/builtin-extension-pack/1.50.1/file/eclipse-theia.builtin-extension-pack-1.50.1.vsix",
    "vscode.markdown-language-features": "https://open-vsx.org/api/vscode/markdown-language-features/1.39.2/file/vscode.markdown-language-features-1.39.2.vsix",
    "vscode-md-preview": "https://open-vsx.org/api/shd101wyy/markdown-preview-enhanced/0.7.6/file/shd101wyy.markdown-preview-enhanced-0.7.6.vsix"
  },
  "theiaPluginsExcludeIds": [
    "ms-vscode.references-view"
  ]
}

[vince-fugnitto]

@yogaprabu you're not making use of the package which contributes the preference or functionality, you need to include @theia/getting-started.

[yogaprabu]

Thank you @msujew and @vince-fugnitto, it's working fine now