Skip to content

Add documentation for plugins#454

Merged
hediet merged 2 commits intohediet:mainfrom
reenberg:feature/docs-plugins
Feb 14, 2025
Merged

Add documentation for plugins#454
hediet merged 2 commits intohediet:mainfrom
reenberg:feature/docs-plugins

Conversation

@reenberg
Copy link
Contributor

@reenberg reenberg commented Feb 14, 2025

  • Added a markdown file in the docs folder that tries to explain how the plugin settings work.

  • Added categories for the settings and ordered them such that related properties are listed close to each other.
    This orders the settings in the following way:

    $ jq -r '.contributes.configuration[] | {title: .title,  order: .order, properties: .properties 
      | keys_unsorted}' package.json                                  
    {
      "title": "General",
      "order": 10,
      "properties": [
        "hediet.vscode-drawio.offline",
        "hediet.vscode-drawio.online-url",
        "hediet.vscode-drawio.codeLinkActivated",
        "hediet.vscode-drawio.local-storage",
        "hediet.vscode-drawio.simpleLabels",
        "hediet.vscode-drawio.zoomFactor",
        "hediet.vscode-drawio.globalVars",
        "hediet.vscode-drawio.resizeImages"
      ]
    }
    {
      "title": "Plugins",
      "order": 20,
      "properties": [
        "hediet.vscode-drawio.plugins",
        "hediet.vscode-drawio.knownPlugins",
        "hediet.vscode-drawio.customLibraries"
      ]
    }
    {
      "title": "Theme and styles",
      "order": 30,
      "properties": [
        "hediet.vscode-drawio.styles",
        "hediet.vscode-drawio.defaultVertexStyle",
        "hediet.vscode-drawio.defaultEdgeStyle",
        "hediet.vscode-drawio.colorNames",
        "hediet.vscode-drawio.presetColors",
        "hediet.vscode-drawio.customColorSchemes",
        "hediet.vscode-drawio.customFonts",
        "hediet.vscode-drawio.theme"
      ]
    }

Closes: #326

Added a markdown file in the docs folder that describes the `plugins` and
`knownPlugins` configuration properties.
- Add categories and sort the settings properties such that they are
  grouped together in a more logical order.

- Add a bit more description to the plugins properties, including a link
  to the new plugin documentation page.
@hediet hediet merged commit fe819cc into hediet:main Feb 14, 2025
3 checks passed
@hediet
Copy link
Owner

hediet commented Feb 14, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation regarding plugin configuration

2 participants