From: Martin Taibr Date: Sun, 12 Feb 2017 16:33:23 +0000 (+0000) Subject: update Editing X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=98199f61888096fab423b34733b6d9cace49f953;p=xonotic%2Fxonotic.wiki.git update Editing --- diff --git a/Editing.md b/Editing.md index 0ca6b44..df6fbad 100644 --- a/Editing.md +++ b/Editing.md @@ -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.