Skip to content

Commit 2054bdf

Browse files
committed
Update Readme.md
1 parent d197023 commit 2054bdf

File tree

1 file changed

+60
-23
lines changed

1 file changed

+60
-23
lines changed

Readme.md

Lines changed: 60 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-t
1414
## Contents
1515
- [Installation](#installation)
1616
- [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)
17+
- [At a glance](#at-a-glance)
18+
- [Default Search](#default-search)
19+
- [Notebook Explorer](#notebook-explorer)
20+
- [Create New Items](#create-new-items)
21+
- [Recent Pages](#recent-pages)
22+
- [Scoped Search](#scoped-search)
23+
- [Title Search](#title-search)
2524
- [Settings](#settings)
2625
- [Keywords](#keywords)
26+
- [2.0 Changelog](#20-changelog)
2727
- [Acknowledgements](#acknowledgements)
2828

2929
## Installation
@@ -35,37 +35,74 @@ pm install OneNote
3535
> Requires at least Flow Launcher version 1.16.
3636
3737
## Features
38-
### Core Features
39-
#### Default Search
38+
### At a glance
39+
| Keyword | Name | Description |
40+
| ---------------------------- | --------------------------------------- | ---------------------------- |
41+
| `` on {your search query} `` | [Default Search](#default-search) | Search OneNote pages |
42+
| `` on nb:\ `` | [Notebook Explorer](#notebook-explorer) | Navigate notebooks hierarchy |
43+
| `` on rcntpgs: `` | [Recent Pages](#recent-pages) | View recently modified pages |
44+
45+
46+
### Default Search
4047
```
41-
on {your search here}
48+
on {your search query}
4249
```
43-
The default mode allows you to search OneNote Pages.
44-
Using `AND` or `OR`
50+
This is allows you to search OneNote pages. The OneNote API searches both the content in a page as well as the page title.
51+
52+
> [!NOTE]
53+
> You can include bitwise operators like `AND` or `OR` (they must be uppercase) in your search. E.g. `on hello there AND general kenobi`.
4554
4655
![default search gif](doc/)
4756

48-
#### Notebook Explorer
57+
### Notebook Explorer
58+
59+
```
60+
on nb:\
61+
```
62+
Transverse your OneNote notebooks explorer style.
63+
64+
- Press <kbd>⏎ Enter</kbd> or <kbd>⇥ Tab</kbd> or left-click on a result to auto complete the query.
65+
- Press <kbd>⇧ Shift</kbd> + <kbd>⏎ Enter</kbd> or right-click on a result to open it directly in OneNote.
66+
67+
see settings for options on recycle bin etc.
4968

50-
Transverse your OneNote Notebooks explorer style
69+
![notebook explorer gif](doc/)
5170

52-
##### Create New Items
71+
> [!INFORMATION]
72+
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
5373
54-
#### Recent Pages
74+
#### Create New Items
5575

56-
### Extra
76+
Whilst using the notebook explorer, if you search query does not match any names of the items in the results, the plugin will give you an option to create a new item.
5777

58-
#### Scoped Search
78+
![create new section gif](doc/)
5979

60-
#### Title Search
80+
> [!INFORMATION]
81+
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
82+
### Recent Pages
83+
84+
```
85+
on rcntpgs:
86+
```
87+
88+
Displays your recently modified OneNote pages.
89+
90+
Add a number after `` rcntpgs: `` to display that number of recent pages. E.g. the full query ``on rcntpgs:10`` will show the 10 most recently modified pages.
91+
92+
![recent pages gif](doc/)
93+
### Scoped Search
94+
95+
### Title Search
6196

6297

6398
## Settings
6499

65100
### Keywords
66101

102+
## 2.0 Changelog
103+
67104
## Acknowledgements
68105

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)
106+
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot.OneNote.Linq) a library for exposing the OneNote API also made by me :smiley:.
107+
- Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote).
108+
- Icons from [Icons8](https://icons8.com).

0 commit comments

Comments
 (0)