From: Martin Taibr Date: Fri, 10 Feb 2017 00:15:35 +0000 (+0000) Subject: editing guide X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=156fffb41f19815c94a9fe5be576587cd5de849a;p=xonotic%2Fxonotic.wiki.git editing guide --- diff --git a/Editing.md b/Editing.md index 056df11..0ca6b44 100644 --- a/Editing.md +++ b/Editing.md @@ -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.