swiftmandolin
/
gemini-style-guide
1
1
Fork 1
Code Issues 3 Pull Requests Releases Wiki Activity

fixed typos and needless information

This commit is contained in:
nytpu 2020-09-08 17:13:02 -06:00
parent 7eb5a65dec
commit 2d42110326
Signed by: nytpu
GPG Key ID: ECCDC07B337B8F5B
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
general-practices.md
View File

@ -1,7 +1,7 @@
# General Best Practices
## File Naming
Filenames should use '-' to replace spaces, and should have no special characters (alphanumeric & dashes only). Gemtext documents should have the extension `.gmi` or `.gemini`. Mixed case can be used, but if you are on a case sensitive filesystem (ext4, etc) you should not have 2 files with the same name and different cases (i.e. 'hello-world.gmi' and 'HELLO-WORLD.gmi')
Filenames should use '-' to replace spaces, and should have no special characters. Gemtext documents should have the extension `.gmi` or `.gemini`. Mixed case can be used, but if you are on a case sensitive filesystem (ext4, etc) you should not have 2 files with the same name and different cases (e.g. 'hello-world.gmi' and 'HELLO-WORLD.gmi')
### Why
This follows the convention for the web and ensures compatibility with most filesystems. Dashes are preferred to underscores as a separator because underscores can be hidden by an underline if a client underlines links.