moonq/mdsnippets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
Q
2023-09-27 19:54:24 +03:00
parent 07d6d5242c
commit 9f9956f7f2
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -9,17 +9,19 @@ See their documentation for language names.
## UI ## UI
* At the top there is a search bar. Enter values to filter snippet names. * At the top there is a search bar. Enter values to filter snippet names.
* Pressing key 's' or / focuses the search bar. * Pressing key 's' or / focuses the search bar.
* Cycling results with TAB shows the code, and selects it
* Copy with keyboard and paste where you want
## Configuration ## Configuration
* config.js config.js:
* File is read to replace values in "config.xx" object. * File is read to replace values in "config.xx" object.
* config.source='path_to_markdown.txt'; * config.source='path_to_markdown.txt';
* config.style='path_to_style.css'; * config.style='path_to_style.css';
* config.title='Title of page'; * config.title='Title of page';
* config.search=true; // Display link search bar * config.search=true; // Display link search bar
* config.favicon='path_to_favicon.ico'; * config.favicon='path_to_favicon.ico';
## Markdown ## Markdown
@@ -30,7 +32,7 @@ Only 1st level heads, names and code blocks are parsed:
name name
\`\`\`python \`\`\`python
print("Hello World!") print("Hello World!")
# Dot escape the ticks in real config. # Do not escape the backticks in real config.
\`\`\` \`\`\`
``` ```