]> git.xonotic.org Git - xonotic/xonotic.wiki.git/commitdiff
update Editing
authorMartin Taibr <taibr.martin@gmail.com>
Sun, 12 Feb 2017 16:33:23 +0000 (16:33 +0000)
committerMartin Taibr <taibr.martin@gmail.com>
Sun, 12 Feb 2017 16:33:23 +0000 (16:33 +0000)
Editing.md

index 0ca6b44836a09acabb5792059710bef12dbce155..df6fbadef9cdcfa527173d394a8ba25ad511ec62 100644 (file)
@@ -5,7 +5,9 @@ The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/hom
 Filenames
 ---------
 
-Use dashes, not underscores - dashes get converted to spaces in titles
+Use dashes, not underscores - dashes get converted to spaces in page titles so we have a nice title on every page
+
+Interestingly, spaces seem to work fine in filenames for both GitHub and GitLab but I am sure they'd break *something somewhere* so let's stick to dashes.
 
 Subdirectories
 --------------
@@ -14,8 +16,13 @@ Ok to use for images and other assets
 
 Don't use for pages (the `.md` files) - GitHub doesn't support them properly (it flattens everything - this can cause collisions, plus there is no way to link from subdir to another subdir that works on both GitLab and GitHub)
 
+ - Put all `.md` files in root
+
 Links to pages
 -------------
 
 Use standard markdown links: `[Text](link)` (e.g. `[Back to index](Home)` to get [Back to index](Home))
+
  - Don't prefix `link` with either `../link` or `/link` - both break on GitHub. Using `./link` seems to work ok but is unnecessary since we have to put everything in root anyway.
+
+Links don't seem to be case sensitive but it's probably best to use proper capitalization just in case it breaks in some edge case somewhere.