Skip to content

Commit d197023

Browse files
committed
Update Readme.md
1 parent 487c161 commit d197023

File tree

1 file changed

+56
-24
lines changed

1 file changed

+56
-24
lines changed

Readme.md

Lines changed: 56 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,71 @@
1-
# OneNote for Flow Launcher
1+
<p align="center">
2+
<a href="https://flowlauncher.com">
3+
<img src="doc/flow.png" width=12.5%>
4+
</a>
5+
<a href="https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-taking-app">
6+
<img src= "doc/onenote.png" width=12.5%>
7+
</a>
8+
</p>
9+
<h1 align="center">OneNote for Flow Launcher</h1>
210

3-
A OneNote plugin for the [Flow launcher](https://github.com/Flow-Launcher/Flow.Launcher), allowing for the ability to quickly access and create notes.
4-
![demo](doc/demo.png)
11+
A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-taking-app) plugin for the [Flow launcher](https://github.com/Flow-Launcher/Flow.Launcher), allowing for the ability to quickly access and create notes.
512

6-
## Features and Usage
13+
<!-- omit from toc -->
14+
## Contents
15+
- [Installation](#installation)
16+
- [Features](#features)
17+
- [Core Features](#core-features)
18+
- [Default Search](#default-search)
19+
- [Notebook Explorer](#notebook-explorer)
20+
- [Create New Items](#create-new-items)
21+
- [Recent Pages](#recent-pages)
22+
- [Extra](#extra)
23+
- [Scoped Search](#scoped-search)
24+
- [Title Search](#title-search)
25+
- [Settings](#settings)
26+
- [Keywords](#keywords)
27+
- [Acknowledgements](#acknowledgements)
728

8-
| Keyword | Name | Description |
9-
|---------------------------------|------|---------------|
10-
| `` on {OneNote search query} `` | [Default Search](#default-search) | Search OneNote pages, searches page title and content |
11-
| `` on nb:\ `` | [Notebook Explorer](#notebook-explorer) | Navigate notebooks, sections and pages explorer style |
12-
| `` on rcntpgs: `` | [Recent Pages](#recent-pages) | View recently modified pages |
29+
## Installation
30+
Using Flow Launcher type:
31+
```
32+
pm install OneNote
33+
```
34+
> [!IMPORTANT]
35+
> Requires at least Flow Launcher version 1.16.
1336
14-
### Default Search
37+
## Features
38+
### Core Features
39+
#### Default Search
40+
```
41+
on {your search here}
42+
```
43+
The default mode allows you to search OneNote Pages.
44+
Using `AND` or `OR`
1545

16-
![searchgif](doc/search_pages.gif)
46+
![default search gif](doc/)
1747

18-
### Notebook Explorer
48+
#### Notebook Explorer
1949

20-
- Allows for creating notebooks at the default notebook location (set in OneNote) as well as sections and pages at the current path.
21-
- Pressing <kbd>⏎ Enter</kbd> or <kbd>⇥ Tab</kbd> on a notebook or section will auto complete the query.
22-
- Pressing <kbd>⇧ Shift</kbd> + <kbd>⏎ Enter</kbd> on a notebook or section allows you to open it directly in OneNote.
23-
- Encrypted sections are hidden.
50+
Transverse your OneNote Notebooks explorer style
2451

25-
![notebookgif](doc/notebook_explorer.gif)
52+
##### Create New Items
2653

27-
### Recent Pages
54+
#### Recent Pages
2855

29-
Add a number after `` rcntpgs: `` to display that number of recent pages. E.g. `` rcntpgs:10 `` will show the 10 most recently modified pages.
56+
### Extra
3057

31-
![recentgif](doc/recent_pages.gif)
58+
#### Scoped Search
59+
60+
#### Title Search
3261

33-
## Acknowledgements
3462

35-
Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote) (Its a port with extra features)
63+
## Settings
3664

37-
Icons from [Icons8](https://icons8.com)
65+
### Keywords
66+
67+
## Acknowledgements
3868

39-
Created with [ScipBe](https://github.com/scipbe/ScipBe-Common-Office) OneNote tools
69+
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot.OneNote.Linq) a library for exposing the OneNote API made by me :smiley:.
70+
- Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote)
71+
- Icons from [Icons8](https://icons8.com)

0 commit comments

Comments
 (0)