]> git.xonotic.org Git - xonotic/xonotic.wiki.git/commitdiff
editing guide
authorMartin Taibr <taibr.martin@gmail.com>
Fri, 10 Feb 2017 00:15:35 +0000 (00:15 +0000)
committerMartin Taibr <taibr.martin@gmail.com>
Fri, 10 Feb 2017 00:15:35 +0000 (00:15 +0000)
Editing.md

index 056df11194ac9ae2d20807a53f51867dd81bdffe..0ca6b44836a09acabb5792059710bef12dbce155 100644 (file)
@@ -1,4 +1,6 @@
-If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/), we'll gladly give it to you. There is no way to allow annoynmous editing on GitLab.
+If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/), we'll gladly give it to you. There is no way to allow anonymous editing on GitLab.
+
+The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/home) but we also sync it to [GitHub](https://github.com/xonotic/xonotic/wiki). Please, follow this guide when editing to make sure the wiki works properly on both.
 
 Filenames
 ---------
@@ -9,11 +11,11 @@ Subdirectories
 --------------
 
 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)
 
-Links
------
+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)
 
-Use standard markdown links: `[Text](link)`, don't prefix `link` with either ".." or "/" - both break on GitHub. Using "." seems ok but is unnecessary since we have to put everything in root anyway.
+Links to pages
+-------------
 
-TODO(martin-t): check that this renders properly everywhere
+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.