https://github.com/fschottmann/CheatSheetCompanion
Cheat Sheet Companion is a powerful PowerShell tool that provides context-sensitive cheat sheets to users. No matter what program or website the user is in, the appropriate cheat sheets are always displayed, making it easier for users to find the information they need quickly and efficiently.
https://github.com/fschottmann/CheatSheetCompanion
gui gui-application obsidian obsidian-md powershell wpf
Last synced: 5 months ago
JSON representation
Cheat Sheet Companion is a powerful PowerShell tool that provides context-sensitive cheat sheets to users. No matter what program or website the user is in, the appropriate cheat sheets are always displayed, making it easier for users to find the information they need quickly and efficiently.
- Host: GitHub
- URL: https://github.com/fschottmann/CheatSheetCompanion
- Owner: fschottmann
- License: apache-2.0
- Created: 2023-02-07T14:53:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T18:56:33.000Z (over 1 year ago)
- Last Synced: 2024-11-20T05:02:56.091Z (about 1 year ago)
- Topics: gui, gui-application, obsidian, obsidian-md, powershell, wpf
- Language: PowerShell
- Homepage:
- Size: 33.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- jimsghstars - fschottmann/CheatSheetCompanion - Cheat Sheet Companion is a powerful PowerShell tool that provides context-sensitive cheat sheets to users. No matter what program or website the user is in, the appropriate cheat sheets are always dis (PowerShell)
README
# CheatSheetCompanion
## About
Cheat Sheet Companion is a powerful PowerShell tool that provides context-sensitive cheat sheets to users.
No matter what program or website the user is using, the appropriate cheat sheets are always displayed,
making it easier for users to find the information they need quickly and efficiently.
It also supports Obsidian and call directly files in the Obsidian vault.
## Workflow explanation
At the start of this program every markdown file will be converted to a HTML file with the correspondig name.
After a few seconds the program searches for the title description of the active window and then the process name
based on the file name similarity (Cosine Similarity).
## Requirements
Powershell 7 x64 - [link](https://github.com/PowerShell/PowerShell)
### Browser engines
Cheat Sheet Companion support the default system browser as well as the [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) engine if installed.
To install the [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) engine
run the following code as an administrator:
```pwsh
Import-Module PackageManagement
Install-Module PowerShellGet -AllowClobber -Force
If ((Get-PackageSource | Where Name -eq nuget.org) -eq $Null){
Register-PackageSource -Name nuget.org -Location https://www.nuget.org/api/v2 -ProviderName NuGet -Trusted
}
Install-Package Microsoft.Web.WebView2 -Source nuget.org
```
## Customization
### INI file
> In this file, you can change the global shortcuts.
```
.\ini\config.ini
```
example:
```
[GlobalShortcut]
AutoSwitch = ControlKey,ShiftKey,F2
DisplayCompanion = ControlKey,ShiftKey,F11
```
### CSS file
> In this file, you can change the graphical appearance.
```
.\styles\userstyle.css
```
The HTML Code will be generated within a body entity with the class "markdown-body".
example:
```
EXAMPLE Header 1
EXAMPLE Header 2
EXAMPLE
Symbol
description
EXAMPLE
```