mirror of
https://tildegit.org/sloum/gemini-vim-syntax.git
synced 2024-08-14 22:46:59 +00:00
Adds license and readme
This commit is contained in:
parent
deb8833369
commit
7b3ff39ca4
2 changed files with 64 additions and 0 deletions
24
LICENSE
Normal file
24
LICENSE
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
This is free and unencumbered software released into the public domain.
|
||||||
|
|
||||||
|
Anyone is free to copy, modify, publish, use, compile, sell, or
|
||||||
|
distribute this software, either in source code form or as a compiled
|
||||||
|
binary, for any purpose, commercial or non-commercial, and by any
|
||||||
|
means.
|
||||||
|
|
||||||
|
In jurisdictions that recognize copyright laws, the author or authors
|
||||||
|
of this software dedicate any and all copyright interest in the
|
||||||
|
software to the public domain. We make this dedication for the benefit
|
||||||
|
of the public at large and to the detriment of our heirs and
|
||||||
|
successors. We intend this dedication to be an overt act of
|
||||||
|
relinquishment in perpetuity of all present and future rights to this
|
||||||
|
software under copyright law.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||||
|
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||||||
|
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
||||||
|
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
|
OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
For more information, please refer to <http://unlicense.org/>
|
40
README.md
Normal file
40
README.md
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
# Gemini Vim Syntax
|
||||||
|
|
||||||
|
This repo contains basic syntax highlighting for the [Gemini protocol](https://gemini.circumlunar.space/)'s *text/gemini* format.
|
||||||
|
|
||||||
|
## How to install
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://tildegit.org/sloum/gemini-vim-syntax
|
||||||
|
cd gemini-vim-syntax
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
|
That should get you up and running. Note that this installs the files for your user, not globally for the system. It should support Linux, Unix/BSD/Darwin, Windows, and Haiku out of the box.
|
||||||
|
|
||||||
|
## What is supported
|
||||||
|
|
||||||
|
The current state of the syntax covers all items officially supported by the [gemini spec](https://gemini.circumlunar.space/docs/spec-spec.txt):
|
||||||
|
|
||||||
|
- Links get colored in three parts:
|
||||||
|
- =>
|
||||||
|
- URL
|
||||||
|
- Link text
|
||||||
|
- Headings
|
||||||
|
- Up to three levels
|
||||||
|
- Lines that start with one, two, or three _\#_ characters
|
||||||
|
- List items
|
||||||
|
- Lines that start with _*_
|
||||||
|
- Preformatted text blocks
|
||||||
|
- Handled as a range that starts and ends with _\`\`\`_
|
||||||
|
|
||||||
|
I plan to update the syntax when and if the spec adds more items to *text/gemini*.
|
||||||
|
|
||||||
|
## Unexpected
|
||||||
|
|
||||||
|
It is possible that Windows users may find that the syntax does not work. I do not have a machine to test it on and would love some feedback. If it is not working it likely has to do with line endings. Windows uses \<cairrage-return\><\<line-feed\> and linux/unix use just \<line-feed\>. There are a number of ways to solve this problem ranging from just replacing the newlines manually to using software. In either case it shouldn't be too difficult.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
All source files are provided under the [unlicense](https://unlicense.org/).
|
||||||
|
|
Loading…
Reference in a new issue