Skip to content

Commit c91af45

Browse files
committed
A lot of small fixes
Fix broken links, fix typos, rephrase complex sentences, fix incorrect markup, simplify markup
1 parent 033a509 commit c91af45

21 files changed

+158
-160
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Welcome
22

3-
Here you will find documentation on usage tips, design information, plugin development and more.
3+
Here you will find documentation on usage tips, design information, plugin development, and more.
44

5-
If you have just started using Flow, please head over to the [Usage Tips](/usage-tips.md) section to find out how you can get the most out of Flow. Otherwise if you are completely new to Flow and want to find out its features and give it a spin, please visit [here](https://github.com/Flow-Launcher/Flow.Launcher/#-features).
5+
If you have just started using Flow, please head over to the [Usage Tips](/usage-tips.md) section to find out how you can get the most out of Flow. Otherwise, if you are completely new to Flow and want to find out its features and give it a spin, please visit [here](https://github.com/Flow-Launcher/Flow.Launcher/#-features).

_coverpage.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
<p align="center">
2-
<a href="https://flow-launcher.github.io">
3-
<img width="250px" src="https://raw.githubusercontent.com/Flow-Launcher/Flow.Launcher/5ba4514f31e624c679628d4dfe89036c0e24006c/Doc/Logo/resources/flow-header-square-transparent.png">
4-
</a>
5-
</p>
1+
<a href="https://www.flowlauncher.com/">
2+
<img
3+
width="250"
4+
src="https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher@5ba4514f31e624c679628d4dfe89036c0e24006c/Doc/Logo/resources/flow-header-square-transparent.png"
5+
alt="Flow Launcher logo"
6+
>
7+
</a>
68

79
# Flow Launcher
810

_sidebar.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
- [**Plugin references**](/nodejs-plugin-references.md)
2323
- Testing Plugins
2424
- [**Testing Guide**](/testing.md)
25-
- JSONRPC
26-
- [**JSON RPC Introduction**](/json-rpc.md)
27-
- [**JSON RPC Plugin Settings**](/json-rpc-settings.md)
25+
- JSON-RPC
26+
- [**Introduction**](/json-rpc.md)
27+
- [**Plugin Settings**](/json-rpc-settings.md)
2828
- Porting Plugins
2929
- [**Porting Plugins Guide**](/port-plugins.md)
3030
- [**How To Create A Theme**](/how-to-create-a-theme.md)

bookmark-custom-locations.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Custom location list
22

33
This page contains the information for setting custom browser locations for the Bookmark plugin that are not included by default.
4-
- These locations may not be the exact path, but they are the typical bookmark location for each browser, you can use them as a reference guide.
5-
- If you are using a browser that is not listed here, please update this document. It will help others.
4+
- These locations may not be the exact path, but they are the typical bookmark location for each browser; you can use them as a reference guide.
5+
- If you are using a browser not listed here, please update this document. It will help others.
66

77
----
88

@@ -14,4 +14,3 @@ This page contains the information for setting custom browser locations for the
1414
**LibreWolf**
1515
- Firefox Engine
1616
- C:\Users\username\AppData\RoamingRoaming\librewolf\Profiles\1tyx98jn.default-default
17-

develop-dotnet-plugins.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
1-
Flow is written in C#, so plugins written in .Net platform can directly communicate with Flow without extra protocols.
1+
Flow is written in C#, so plugins written in .NET platform can directly communicate with Flow without extra protocols.
22

33
## Initialization
44

55
For C# Plugins, We recommend you use the [dotnet template](https://github.com/Flow-Launcher/dotnet-template) to generate a plugin template.
66

7-
In order to be recognized as a Flow DotNet plugin, the directory needs to have at least two files
8-
1. [`plugin.json`](plugin.json.md)
9-
2. A Dotnet Assembly that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** or **[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.
7+
To be recognized as a Flow DotNet plugin, the directory needs to have at least two files
8+
1. [`plugin.json`](/plugin.json.md)
9+
2. A Dotnet Assembly that implements **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** or **[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.
1010

11-
Find our API Reference [here](API-Reference/)
11+
Find our API Reference [here](/API-Reference/Flow.Launcher.Plugin.md)
1212

1313

1414
A sample CSharp Plugin [here](https://github.com/Flow-Launcher/plugin-samples)
1515

1616
## IPlugin/IAsyncPlugin
1717

18-
The `Main`class that implements **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** or **[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** will handle the query search with Flow.
18+
The `Main`class that implements **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** or **[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** will handle the query search with Flow.
1919

20-
**[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)** interface contains two required methods:
20+
**[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** interface contains two required methods:
2121
1. `void Init(PluginInitContext context)`
22-
- [PluginInitContext](https://github.com/Flow-Launcher/Flow.Launcher/blob/master/API-Reference/Flow.Launcher.Plugin/PluginInitContext.cs) exposes some API from Flow and an metadata object for your plugin.
22+
- [PluginInitContext](/API-Reference/Flow.Launcher.Plugin/PluginInitContext.md) exposes some API from Flow and a metadata object for your plugin.
2323
- It will be invoked before the invocation of `Query`, so you can do some preparation here.
2424
- We recommend you do expensive operations in this method instead of Object Constructor because this method will be executed in parallel with other plugins.
2525
2. `List<Result> Query(Query query)`
26-
- `Query` will be invoked when user activate this plugin with specific ActionKeyword.
27-
- A `List` of [Result](/API-Reference/Flow.Launcher.Plugin/result.md) object should be returned.
26+
- `Query` will be invoked when user activates this plugin with specific ActionKeyword.
27+
- A `List` of [Result](/API-Reference/Flow.Launcher.Plugin/Result.md) object should be returned.
2828

29-
**[IAsyncPlugin](API-Reference/Flow.Launcher.Plugin/iasyncplugin.md)** is the async version of **[IPlugin](API-Reference/Flow.Launcher.Plugin/iplugin.md)**
29+
**[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** is the async version of **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)**
3030
- Instead of implementing `Init` and `Query`, you will need to implement `InitAsync`and `QueryAsync`, which use `Task`,`Task<List<Result>` as return value to allow using `async/await` strategy
3131
- `QueryAsync` provides a `CancellationToken token` to allow you to check whether user has typed a new query.
3232

3333

3434
## Additional interfaces
3535

36-
Besides the basic implementation of **IPlugin/IAsyncPlugin**, plugins can also implement a series of interfaces that belongs to **IFeatures** to control more communication with Flow.
36+
Besides the basic implementation of **IPlugin/IAsyncPlugin**, plugins can also implement a series of interfaces that belong to **IFeatures** to control more communication with Flow.
3737

3838
**Remarks**: You should implement these interfaces in the same class that implements **IPlugin/IAsyncPlugin**.
3939

40-
### [IContextMenu](API-Reference/Flow.Launcher.Plugin/icontextmenu.md)
40+
### [IContextMenu](/API-Reference/Flow.Launcher.Plugin/IContextMenu.md)
4141

4242
`LoadContextMenus` will be invoked when users expand the context menu of a specific Result.
4343
The return value of `LoadContextMenus` is similar to Results from `Query/QueryAsync`.
4444

45-
### [IReloadable](API-Reference/Flow.Launcher.Plugin/ireloadable.md)/[IAsyncReloadable](API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md)
45+
### [IReloadable](/API-Reference/Flow.Launcher.Plugin/IReloadable.md)/[IAsyncReloadable](API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md)
4646

4747
`ReloadData/ReloadDataAsync` will be invoked when users click the `Reload Plugin Data` command from _sys_ plugin. Generally, it is used to reload some cache (such as the programs information cached in _Program_ plugin).
4848

49-
### [IPluginI18n](/API-Reference/Flow.Launcher.Plugin/iplugini18n.md)
49+
### [IPluginI18n](/API-Reference/Flow.Launcher.Plugin/IPluginI18n.md)
5050

5151
**IPluginI18n** means the plugin has been internationalized. Therefore, Flow will load the additional language resources from `/Languages` when loading the plugin.
5252
By implementing this interface with additional language files, Flow will be able to load plugin-specific localized language resources. You will be able to get the translated text with `IPublicAPI.GetTranslation(string key)`.
@@ -60,13 +60,13 @@ The Language Resource file will need to be a list of **key/value** pair. Follow
6060

6161
Plugins are required to implement **IPublicI18n** to let Flow load Language resources.
6262

63-
### [IResultUpdated](API-Reference/Flow.Launcher.Plugin/iresultupdated.md)
63+
### [IResultUpdated](/API-Reference/Flow.Launcher.Plugin/IResultUpdated.md)
6464

6565

66-
Implementing **IResultUpdated** provides a way to return part of the query results early. This is generally useful for plugins with long running queries.
66+
Implementing **IResultUpdated** provides a way to return part of the query results early. This is generally useful for plugins with long-running queries.
6767

6868
To early return a result to Flow, you will need to invoke `ResultUpdated` event with an `ResultUpdatedEventArgs`, which includes the current `Query` object and the List of `Result` objects similar to the return value in `Query(Async)`.
6969

7070
### [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable) *Flow 1.8.0 or higher*
7171

72-
Implementing **IDisposable** to dispose unmanaged resource in the plugin. `Dispose()` will be called when Flow exit.
72+
Implementing **IDisposable** to dispose unmanaged resource in the plugin. `Dispose()` will be called when Flow exit.

0 commit comments

Comments
 (0)