improve readme
This commit is contained in:
20
README.md
20
README.md
@@ -9,17 +9,19 @@ See their documentation for language names.
|
||||
## UI
|
||||
|
||||
* 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
|
||||
|
||||
* config.js
|
||||
* File is read to replace values in "config.xx" object.
|
||||
* config.source='path_to_markdown.txt';
|
||||
* config.style='path_to_style.css';
|
||||
* config.title='Title of page';
|
||||
* config.search=true; // Display link search bar
|
||||
* config.favicon='path_to_favicon.ico';
|
||||
config.js:
|
||||
* File is read to replace values in "config.xx" object.
|
||||
* config.source='path_to_markdown.txt';
|
||||
* config.style='path_to_style.css';
|
||||
* config.title='Title of page';
|
||||
* config.search=true; // Display link search bar
|
||||
* config.favicon='path_to_favicon.ico';
|
||||
|
||||
## Markdown
|
||||
|
||||
@@ -30,7 +32,7 @@ Only 1st level heads, names and code blocks are parsed:
|
||||
name
|
||||
\`\`\`python
|
||||
print("Hello World!")
|
||||
# Dot escape the ticks in real config.
|
||||
# Do not escape the backticks in real config.
|
||||
\`\`\`
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user