flow-launcher / docs Goto Github PK

• @Zeroto521 is it possible to remove this title? seems excessive:

• Lets change this to 'Flow Launcher' without the dot:

Set up workflow to auto generate C# API documentation on each new deployment of flow's API.

Use:
https://ejball.com/XmlDocMarkdown/

Manual generation:
Create a console project reference back to the Flow.Launcher.Plugin project, and follow the instruction to generate the document.

For some reason all of the plugin references (https://www.flowlauncher.com/docs/#/py-plugin-references) seem to implement a different API than the hello world plugin. It looks like because they're porting from Wox using the flox library, maybe?

So if I am opening a context menu, I need to pass through some kind of unique ID for whichever query result was selected. In the Steam plugin (https://github.com/Garulf/Steam-Search/blob/main/plugin/main.py) they're passing a 'context' variable through the 'add_item' method and getting that data in the data array, first index (data[0]).

In the Hello World example though, how can I get a UID for whichever query item was selected when entering the context menu?

For example, I want to be able to see only the list of windows from the window walker plugin. Is there a way to do this?

Advice for title level

For docsify, tabside is the level one (#).

So docs' title should start from level two (##).

If the doc has only one title, there should delete the title and just keep the content.

Problem title docs

• usage-tips.md: remove the title
• Plugins.md: remove the title.
• port-plugins.md: the title level should start from level two, delete Porting Plugins and Wox/PowerToys Run.

I think Github Pages doesn't work well in China. Is it possible to deploy our document in vercel instead? They provide a much better cdn for accessing in China.

Hey, just a heads up that for the plugins directory wiki page, text seems to overflow if it is too long rather than wrapping.

This only appears to occur for single words that are too long. The only instance of this is the Flow.Plugin.UrlEncode plugin:

This seems to overflow because the single word is too long. On the other hand, multi-word plugins like Epic Game Store Launcher wrap properly since they are multiple words.

I don't know if this is intended or not, but this is just a notice. Feel free to close the issue if it's intended.

Vote for themes to fix some problems:

• The sidebar text aligned problem.
• The title is too long and the text is too big, this causes to overflow sidebar.

The followings are our using or used themes.
And there are two rest official themes see https://docsify.js.org/#/themes?id=click-to-preview.

Others themes from 3rd part, see https://jhildenbiddle.github.io/docsify-themeable/#/

Add section on how to test local plugin- place in plugin folder, or can also use pm install via link.

https://github.com/Flow-Launcher/docs/runs/2813647245?check_suite_focus=true

The docs suggest downloading NodeJS v16 (nodejs-develop-plugins.md#L14), which has reached its end-of-life date last year. Maybe update should be considered?