Skip to content

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.

License

Notifications You must be signed in to change notification settings

fschottmann/CheatSheetCompanion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Browser engines

Cheat Sheet Companion support the default system browser as well as the WebView2 engine if installed.
To install the WebView2 engine
run the following code as an administrator:

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:

<html>
	<head>
		<meta charset="UTF-8">
		</head>
		<body class="markdown-body">
			<h1 id="EXAMPLE_H1">EXAMPLE Header 1</h1>
			<h2 id="EXAMPLE_H2">EXAMPLE Header 2</h2>
			<p>EXAMPLE
			<table>
			<thead>
				<tr>
					<th>Symbol</th>
					<th>description</th>
				</tr>
			</thead>
			<tbody>
				<tr>
					<td>
						<p>EXAMPLE</p>
					</td>
					<td></td>
				</tr>
			</tbody>
		</table>
	</body>
</html>

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 in, the appropriate cheat sheets are always displayed, making it easier for users to find the information they need quickly and efficiently.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published