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

Added "General Best Practices" page and fixed minor formatting issues #1

Merged
swiftmandolin merged 5 commits from nytpu/gemini-style-guide:master into master 2020-09-09 03:28:42 +00:00
Conversation 1 Commits 5 Files Changed 4 +1 -1
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 2d42110326 - Show all commits

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.