From 2662430f8fa2b5fb73b2d3a7f8701ac2950cd0b7 Mon Sep 17 00:00:00 2001 From: nytpu Date: Tue, 8 Sep 2020 16:58:43 -0600 Subject: [PATCH] added general best practices page --- README.md | 1 + general-practices.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 general-practices.md diff --git a/README.md b/README.md index 7daac89..28d1707 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ Reading nytpu's post (1) on formatting definitely got me thinking about formatti (2): gemini://gemini.circumlunar.space/~swiftmandolin/gemlog/2020-09-07-re-experimenting-with-ways-to-format-documents-on-gemini.gmi ## Table of Contents +[general best practices](general-practices.md) [gemlog](gemlog.md) To contribute, please see [the contribution guide](https://tildegit.org/swiftmandolin/gemini-style-guide/src/branch/master/CONTRIBUTING.md) diff --git a/general-practices.md b/general-practices.md new file mode 100644 index 0000000..ea56224 --- /dev/null +++ b/general-practices.md @@ -0,0 +1,34 @@ +# 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') + +### 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. + +### Example +``` +my-cool-page.gmi +``` + +## Preformatted alt text +The alt text after the opening preformatted text line (`````text here``) should be used as an alt text describing the content if it is not machine-readable. For instance, ASCII art should have a brief description in the alt text, but a code block does not need alt text. + +### Why +This ensures that people using gemini with something like a screen reader are able to understand all the aspects of the site. + +### Example + ```ascii banner saying "ART" + _ ____ _____ + / \ | _ \_ _| + / _ \ | |_) || | + / ___ \| _ < | | + /_/ \_\_| \_\|_| + ``` + +## Links +TODO: probably similar to gemlog links + +## Navigation +TODO: probably similar to gemlog links with some modifications +