├── LICENSE ├── README.md └── markdown.csv /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Blaine Mooers and the University of Oklahoma Board of Regents 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Version](https://img.shields.io/static/v1?label=markdown-jupyter-voice-in&message=0.3&color=brightcolor) 2 | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) 3 | 4 | # Markdown snippets for Jupyter in Voice-In Plus 5 | 6 | This is a collection of about 90 voice snippets to support writing in markdown cells of Jupyter notebooks using the Voice In Plus plug-in for Google Chrome and Microsoft Edge web browsers. 7 | The voice triggers and associated text replacements are stored in the left and right columns of the *markdown.csv* file. 8 | Read this file to learn tab triggers. 9 | 10 | ## Demo video 11 | Demo includes using built-in `Voice In` commands to delete wrong words and start new lines. 12 | 13 | Note that the imaginary *i*'s were capitalized in the rendered equation by mistake; they are in lowercase in the LaTeX code inserted by Voice In Plus. 14 | The equation renders correctly in [latexit](https://pierre.chachatelier.fr/latexit). 15 | Worked fine when I rendered in Jupyter Lab a week later. 16 | 17 | 18 | https://github.com/MooersLab/markdown-jupyter-voice-in/assets/15176203/b43a8a17-dbfa-4998-8f26-5b8dec5a6f0e 19 | 20 | 21 | ## Installation and use 22 | 23 | 1. Load the markdown.csv file by copying its contents and pasting these into the text area opened by double-clicking on the **bulk add** button on the configuration page for your Voice In Plus account. 24 | 2. Any existing voice commands with the same voice trigger (i.e., voice command in the left column) will be overwritten. 25 | 3. Convert an empty code cell into a markdown cell by entering `m`. 26 | 4. Activate the Voice-In plugin (I use the option-L key binding on my Mac). 27 | 6. Say the voice trigger to invoke the insertion of the corresponding code fragment. 28 | 7. Deactivate the Voice-In plugin (not always essential). 29 | 8. Hit Control-Enter to execute the markdown code block when ready to render it. 30 | 31 | ## Related repositories 32 | 33 | - [Voice snippets for code cells in Jupyter notebooks](https://github.com/MooersLab/jupyter-voice-in) 34 | 35 | ## Related projects 36 | 37 | - [jupyter-voice-in](https://github.com/MooersLab/jupyter-voice-in) 38 | - [voice-in-basics-quiz](https://github.com/MooersLab/voice-in-basics-quiz) 39 | - [arviz-voice-in](https://github.com/MooersLab/arviz-voice-in) 40 | - [matplotlib-voice-in](https://github.com/MooersLab/matplotlib-voice-in) 41 | - [pandas-voice-in](https://github.com/MooersLab/pandas-voice-in) 42 | - [numpy-voice-in](https://github.com/MooersLab/numpy-voice-in) 43 | - [statsmodels-voice-in](https://github.com/MooersLab/statsmodels-voice-in) 44 | - [jupyter-voice-in](https://github.com/MooersLab/jupyter-voice-in) 45 | - [python-voice-in](https://github.com/MooersLab/python-voice-in) 46 | - [cmdstanpy-voice-in](https://github.com/MooersLab/cmdstanpy-voice-in) 47 | - [scipy-voice-in](https://github.com/MooersLab/scipy-voice-in) 48 | 49 | ## Update Table 50 | |Version | Changes | Date | 51 | |:-------------|:------------------------------------------------------------------------------------------------------------------------------------------|:--------------------:| 52 | | Version 0.1 | Initiated with 90 voice snippets. Added badges and update table | 2024 April 14 | 53 | | Version 0.2 | Clarified the instructions in the README.md file. | 2024 April 20 | 54 | | Version 0.2.1 | Added demo video to README.md file. | 2024 April 25 | 55 | | Version 0.3 | Added list of related projects. | 2024 August 8 | 56 | 57 | ## Funding 58 | - NIH R01 CA242845 59 | - NIH R01 AI088011 60 | - NIH P30 CA225520 (PI: R. Mannel) 61 | - NIH P20GM103640 and P30GM145423 (PI: A. West) 62 | 63 | -------------------------------------------------------------------------------- /markdown.csv: -------------------------------------------------------------------------------- 1 | display electron density equation,$$\rho (xyz) = (1/V) \textstyle\sum\limits_{h} \textstyle\sum\limits_{k} \textstyle\sum\limits_{l} |F (hkl)| \exp [- 2 \pi i (hx + ky + lz)+ i \alpha (hkl)]$$ 2 | equation electron density,\begin{equation}\rho (xyz) = (1/V) \textstyle\sum\limits_{h} \textstyle\sum\limits_{k} \textstyle\sum\limits_{l} |F (hkl)| \exp [- 2 \pi i (hx + ky + lz)+ i \alpha (hkl)]\end{equation} 3 | header 1,# Header 1 4 | header one,# Header 1 5 | head or one,# Header 1 6 | head of one,# Header 1 7 | head of 1,# Header 1 8 | head or 1,# Header 1 9 | headed to,## Header 2 10 | header 2,## Header 2 11 | header to,## Header 2 12 | header 2,## Header 2 13 | header 2,## Header 2 14 | header 2,## Header 2 15 | header 2,## Header 2 16 | header two,## Header 2 17 | header two,## Header 2 18 | header to,## Header 2 19 | head or two,## Header 2 20 | header too,## Header 2 21 | head or two,## Header 2 22 | head of two,## Header 2 23 | header to,## Header 2 24 | header to,## Header 2 25 | header three,### Header 3 26 | header 3,### Header 3 27 | head or three,### Header 3 28 | header three,### Header 3 29 | head or three,### Header 3 30 | head her four,## Header 4 31 | head her for,## Header 4 32 | head her 4,## Header 4 33 | header 4,#### Header 4 34 | header four,#### Header 4 35 | head or four,#### Header 4 36 | header four,#### Header 4 37 | header for,#### Header 4 38 | head of four,#### Header 4 39 | head of 4,#### Header 4 40 | header five,##### Header 5 41 | header 5,##### Header 5 42 | head or 5,#### Header 5 43 | head or five,##### Header 5 44 | head of 5,##### Header 5 45 | head of five,##### Header 5 46 | header 6,###### Header 6 47 | header six,###### Header 6 48 | head or six,###### Header 6 49 | head or 6,###### Header 6 50 | header six,#### Header 6 51 | header six,###### Header 6 52 | head or six,###### Header 6 53 | head of six,###### Header 6 54 | head or 6,###### Header 6 55 | head of 6,###### Header 6 56 | markdown bold text,**bold text** 57 | bold text,**bold text** 58 | markdown italics text,*italic text* 59 | italics text,*italic text* 60 | markdown bold italic text,***bold italic text*** 61 | bold italic text,***bold italic text*** 62 | markdown strike through text,~~strike through text~~ 63 | strike through text,~~strike through text~~ 64 | markdown nested blocks,"> some text 65 | >> and then some more text 66 | >>> and then some more" 67 | nested blocks,"> some text 68 | >> and then some more text 69 | >>> and then some more" 70 | markdown horizontal line,--- 71 | horizontal line,--- 72 | ordered list,"1. xxxx 73 | 2. yyyy 74 | 3. zzzz" 75 | markdown ordered list,"1. xxxx 76 | 2. yyyy 77 | 3. zzzz" 78 | markdown ordered list,"1. xxxx 79 | 2. yyyy 80 | 3. zzzz" 81 | unordered list,"- aaaaa 82 | - bbbbb 83 | - ccccc" 84 | markdown unordered list,"- aaaaa 85 | - bbbbb 86 | - ccccc" 87 | markdown image,![](https://www.python.org/static/community_logos/python-logo-master-v3-TM.png "Python Logo") 88 | hyperlink,[click me](https://en.wikipedia.org "Wikipedia") 89 | anchor link,[Section title](#My-Great-Heading) 90 | task list,"- [x] A1 task 91 | - [ ] A2 task 92 | - [ ] A3 task 93 | - [ ] B1 task 94 | - [ ] B2 task 95 | - [ ] C1 task 96 | " 97 | python code block,"```python 98 | s = 'Python syntax highlighting' 99 | print s 100 | ```" 101 | table right aligned,"|Header|Header|Header| 102 | |------:|------:|------:| 103 | |A |B |C | 104 | |X |Y |Z |" 105 | table centered,"|Header|Header|Header| 106 | |:------:|:------:|:------:| 107 | |A |B |C | 108 | |X |Y |Z |" 109 | table left aligned,"|Header|Header|Header| 110 | |:------|:------|:------| 111 | |A |B |C | 112 | |X |Y |Z |" 113 | markdown definition list,"
114 |
First Term
115 |
This is the definition of the first term.
116 |
Second Term
117 |
This is one definition of the second term.
118 |
This is another definition of the second term.
119 |
" 120 | definition list,"
121 |
First Term
122 |
This is the definition of the first term.
123 |
Second Term
124 |
This is one definition of the second term.
125 |
This is another definition of the second term.
126 |
" 127 | markdown navigation menu,"" 131 | navigation menu,"" 135 | --------------------------------------------------------------------------------