Tinymist Docs

Configurations

  1. tinymist.projectResolutiontinymist.projectResolution:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.projectResolution.desc%

    • Valid values:

      • singleFilesingleFile: %extension.tinymist.config.tinymist.projectResolution.string.enum.singleFile%

      • lockDatabaselockDatabase: %extension.tinymist.config.tinymist.projectResolution.string.enum.lockDatabase%

    • Default: singleFilesingleFile
  2. tinymist.outputPathtinymist.outputPath:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.outputPath.desc%

    • Default: """"
  3. tinymist.exportTargettinymist.exportTarget:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.exportTarget.desc%

    • Valid values:

      • pagedpaged: %extension.tinymist.config.tinymist.exportTarget.string.enum.paged%

      • htmlhtml: %extension.tinymist.config.tinymist.exportTarget.string.enum.html%

    • Default: pagedpaged
  4. tinymist.exportPdftinymist.exportPdf:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.exportPdf.desc%

    • Valid values:

      • nevernever: %extension.tinymist.config.tinymist.exportPdf.string.enum.never%

      • onSaveonSave: %extension.tinymist.config.tinymist.exportPdf.string.enum.onSave%

      • onTypeonType: %extension.tinymist.config.tinymist.exportPdf.string.enum.onType%

      • onDocumentHasTitleonDocumentHasTitle: %extension.tinymist.config.tinymist.exportPdf.string.enum.onDocumentHasTitle%

    • Default: nevernever
  5. tinymist.rootPathtinymist.rootPath:

    • Type: string | nullstring | null
    • Description: %extension.tinymist.config.tinymist.rootPath.desc%

  6. tinymist.configureDefaultWordSeparatortinymist.configureDefaultWordSeparator:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.configureDefaultWordSeparator.string.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.configureDefaultWordSeparator.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.configureDefaultWordSeparator.string.enum.disable%

    • Default: disabledisable
  7. tinymist.semanticTokenstinymist.semanticTokens:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.semanticTokens.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.semanticTokens.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.semanticTokens.string.enum.disable%

    • Default: enableenable
  8. tinymist.lint.enabledtinymist.lint.enabled:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.lint.enabled.desc%

    • Default: falsefalse
  9. tinymist.lint.whentinymist.lint.when:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.lint.when.desc%

    • Valid values:

      • onSaveonSave: %extension.tinymist.config.tinymist.lint.when.string.enum.onSave%

      • onTypeonType: %extension.tinymist.config.tinymist.lint.when.string.enum.onType%

    • Default: onSaveonSave
  10. tinymist.typingContinueCommentsOnNewlinetinymist.typingContinueCommentsOnNewline:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.typingContinueCommentsOnNewline.desc%

    • Default: truetrue
  11. tinymist.onEnterEventtinymist.onEnterEvent:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.onEnterEvent.desc%

    • Default: truetrue
  12. tinymist.systemFontstinymist.systemFonts:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.systemFonts.desc%

    • Default: truetrue
  13. tinymist.fontPathstinymist.fontPaths:

    • Type: array | nullarray | null
    • Description: %extension.tinymist.config.tinymist.fontPaths.desc%

  14. tinymist.compileStatustinymist.compileStatus:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.compileStatus.desc%

    • Valid values:

      • enableenable:
      • disabledisable:
    • Default: enableenable
  15. tinymist.statusBarFormattinymist.statusBarFormat:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.statusBarFormat.desc%

    • Default: {compileStatusIcon} {wordCount} [{fileName}]{compileStatusIcon} {wordCount} [{fileName}]
  16. tinymist.typstExtraArgstinymist.typstExtraArgs:

    • Type: arrayarray

      • Items: stringstring
      • Description:
    • Description: %extension.tinymist.config.tinymist.typstExtraArgs.desc%

    • Default: []
  17. tinymist.serverPathtinymist.serverPath:

    • Type: string | nullstring | null
    • Description: %extension.tinymist.config.tinymist.serverPath.desc%

  18. tinymist.trace.servertinymist.trace.server:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.trace.server.desc%

    • Valid values:

      • offoff:
      • messagesmessages:
      • verboseverbose:
    • Default: offoff
  19. tinymist.formatterModetinymist.formatterMode:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.formatterMode.desc%

    • Valid values:

      • disabledisable: %extension.tinymist.config.tinymist.formatterMode.string.enum.disable%

      • typstyletypstyle: %extension.tinymist.config.tinymist.formatterMode.string.enum.typstyle%

      • typstfmttypstfmt: %extension.tinymist.config.tinymist.formatterMode.string.enum.typstfmt%

    • Default: typstyletypstyle
  20. tinymist.formatterPrintWidthtinymist.formatterPrintWidth:

    • Type: numbernumber
    • Description: %extension.tinymist.config.tinymist.formatterPrintWidth.desc%

    • Default: 120
  21. tinymist.formatterIndentSizetinymist.formatterIndentSize:

    • Type: numbernumber
    • Description: %extension.tinymist.config.tinymist.formatterIndentSize.desc%

    • Default: 2
  22. tinymist.formatterProseWraptinymist.formatterProseWrap:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.formatterProseWrap.desc%

    • Default: falsefalse
  23. tinymist.showExportFileIntinymist.showExportFileIn:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.showExportFileIn.desc%

  24. tinymist.dragAndDroptinymist.dragAndDrop:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.dragAndDrop.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.dragAndDrop.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.dragAndDrop.string.enum.disable%

    • Default: enableenable
  25. tinymist.copyAndPastetinymist.copyAndPaste:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.copyAndPaste.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.copyAndPaste.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.copyAndPaste.string.enum.disable%

    • Default: enableenable
  26. tinymist.renderDocstinymist.renderDocs:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.renderDocs.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.renderDocs.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.renderDocs.string.enum.disable%

    • Default: enableenable
  27. tinymist.completion.triggerOnSnippetPlaceholderstinymist.completion.triggerOnSnippetPlaceholders:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.completion.triggerOnSnippetPlaceholders.desc%

    • Default: falsefalse
  28. tinymist.completion.symboltinymist.completion.symbol:

    • Type: stringstring
    • Description: Whether to make symbol completion stepless. For example, $ar|$$ar|$ will be completed to $arrow.r$$arrow.r$. Hint: Restarting the editor is required to change this setting.

    • Valid values:

      • stepstep: Complete symbols step by step

      • steplessstepless: Complete symbols steplessly

    • Default: stepstep
  29. tinymist.completion.postfixtinymist.completion.postfix:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.completion.postfix.desc%

    • Default: truetrue
  30. tinymist.completion.postfixUfcstinymist.completion.postfixUfcs:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.completion.postfixUfcs.desc%

    • Default: truetrue
  31. tinymist.completion.postfixUfcsLefttinymist.completion.postfixUfcsLeft:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.completion.postfixUfcsLeft.desc%

    • Default: truetrue
  32. tinymist.completion.postfixUfcsRighttinymist.completion.postfixUfcsRight:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.completion.postfixUfcsRight.desc%

    • Default: truetrue
  33. tinymist.previewFeaturetinymist.previewFeature:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.previewFeature.desc%

    • Valid values:

      • enableenable: %extension.tinymist.config.tinymist.previewFeature.string.enum.enable%

      • disabledisable: %extension.tinymist.config.tinymist.previewFeature.string.enum.disable%

    • Default: enableenable
  34. tinymist.preview.sysInputstinymist.preview.sysInputs:

    • Type: objectobject
    • Description: %extension.tinymist.config.tinymist.preview.sysInputs.desc%

    • Default: (:)(:)
  35. tinymist.preview.systemFontstinymist.preview.systemFonts:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.preview.systemFonts.desc%

    • Default: truetrue
  36. tinymist.preview.fontPathstinymist.preview.fontPaths:

    • Type: arrayarray

      • Items: stringstring
      • Description: %extension.tinymist.config.tinymist.preview.fontPaths.items.desc%

    • Description: %extension.tinymist.config.tinymist.preview.fontPaths.desc%

    • Default: []
  37. tinymist.preview.refreshtinymist.preview.refresh:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.preview.refresh.desc%

    • Valid values:

      • onSaveonSave: %extension.tinymist.config.tinymist.preview.refresh.string.enum.onSave%

      • onTypeonType: %extension.tinymist.config.tinymist.preview.refresh.string.enum.onType%

    • Default: onTypeonType
  38. tinymist.preview.scrollSynctinymist.preview.scrollSync:

    • Type: stringstring
    • Description: %extension.tinymist.config.tinymist.preview.scrollSync.desc%

    • Valid values:

      • nevernever: %extension.tinymist.config.tinymist.preview.scrollSync.string.enum.never%

      • onSelectionChangeByMouseonSelectionChangeByMouse: %extension.tinymist.config.tinymist.preview.scrollSync.string.enum.onSelectionChangeByMouse%

      • onSelectionChangeonSelectionChange: %extension.tinymist.config.tinymist.preview.scrollSync.string.enum.onSelectionChange%

    • Default: onSelectionChangeByMouseonSelectionChangeByMouse
  39. tinymist.preview.partialRenderingtinymist.preview.partialRendering:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.preview.partialRendering.desc%

    • Default: truetrue
  40. tinymist.preview.invertColorstinymist.preview.invertColors:

    • Type: string | objectstring | object
    • Description: %extension.tinymist.config.tinymist.preview.invertColors.desc%

  41. tinymist.preview.cursorIndicatortinymist.preview.cursorIndicator:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.preview.cursorIndicator.desc%

    • Default: falsefalse
  42. tinymist.preview.pinPreviewFiletinymist.preview.pinPreviewFile:

    • Type: booleanboolean
    • Description: %extension.tinymist.config.tinymist.preview.pinPreviewFile.desc%

    • Default: falsefalse