]> git.xonotic.org Git - xonotic/xonotic.wiki.git/blobdiff - Editing.md
attempt to fix formatting
[xonotic/xonotic.wiki.git] / Editing.md
index bdf99b7d7088ef5914805b9939ae2a77b9352b73..e2e236daef05a71e38777912de04ef00e5983fb4 100644 (file)
@@ -5,6 +5,8 @@ The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/hom
 Filenames
 ---------
 
+For pages, capitalize at least the first letter of the filename (GitHub doesn't capitalize titles automatically).
+
 Use dashes in page names, not underscores - dashes get converted to spaces in page titles so we have a nice title on every page. Some pages might have underscores in names for historical reasons - they already have many outside links (from forums, etc.) pointing to them.
 
 Interestingly, spaces in filenames and links seem to work fine for both GitHub and GitLab, not sure if they break somewhere else, it might still be best to avoid them.
@@ -26,4 +28,4 @@ Links don't seem to be case sensitive but it's probably best to use proper capit
 Automated checking
 -------------------
 
-Neither GL not GH support red links (highlighting broken links) so there's a script in [`assets/check-and-fix.py`](assets/check-and-fix.py) that does it. You can clone the wiki and run it in the root to find broken links and unreachable files. It'll also move or rename files that don't follow the above guidelines, use `--dry-run` to prevent that (or you can just revert the changes with git).
+Neither GL not GH support red links (highlighting broken links) so there's a script in [`assets/check-and-fix.py`](assets/check-and-fix.py) that finds broken links and unreachable files. To use it, clone the wiki and run the script in its root. It can also automatically move or rename files that don't follow the above guidelines if you run it with `--fix`.