Update 'writing_sigils.md'

This commit is contained in:
sose 2021-04-28 00:23:29 +00:00
parent 565c77d316
commit c40256e86b
1 changed files with 4 additions and 4 deletions

View File

@ -1,15 +1,15 @@
# how to write a sigil # How to write a sigil
## requirements ## Requirements
- a text editor - a text editor
- a browser - a browser
- some knowledge of javascript - some knowledge of javascript
## getting started ## Getting started
Say we want to write a sigil for "https://time.is" to get the current times Say we want to write a sigil for "https://time.is" to get the current times
around the world and serve them in gemtext format. Our first step is to create around the world and serve them in gemtext format. Our first step is to create
the file `time.is` and place it in the `sigils` directory. the file `time.is` and place it in the `sigils` directory.
## writing the sigil ## Writing the sigil
The only necessary part of any sigil is the call to The only necessary part of any sigil is the call to
`window.electron.send_gemtext()`. This function sends any data generated in `window.electron.send_gemtext()`. This function sends any data generated in
the browser to the web server. the browser to the web server.