diff options
author | fauxpark <fauxpark@gmail.com> | 2019-11-24 03:07:15 +1100 |
---|---|---|
committer | Joel Challis <git@zvecr.com> | 2019-11-23 16:07:15 +0000 |
commit | 9ea9806d67dd3dfd775cf854b9becd35f3cdc748 (patch) | |
tree | 012f98bfce95f8bb324b98a8f137e35af9d9ee78 /docs/contributing.md | |
parent | 7874f297b384893a842e5d5cd953264eb3561b7c (diff) | |
download | qmk_firmware-9ea9806d67dd3dfd775cf854b9becd35f3cdc748.tar.gz |
Set up language fallback for docs, and update translation guidelines (#7403)
* Set up language fallback for docs, and update translation guidelines
* Title Case
* Add ID example
* Link to emoji flag cheatsheet
* Move docs preview section to contributing.md
* Point to docs preview in the readme
Diffstat (limited to 'docs/contributing.md')
-rw-r--r-- | docs/contributing.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 04dc0da20..7c365b418 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -101,6 +101,18 @@ enum my_keycodes { }; ``` +### Previewing the Documentation + +Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder: + + ./bin/qmk docs + +or if you only have Python 3 installed: + + python3 -m http.server 8936 + +and navigating to `http://localhost:8936/`. + ## Keymaps Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap. |