drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Set up language fallback for docs, and update translation guidelines (#7403)

Browse source 
* 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
This commit is contained in:
fauxpark 2019-11-24 03:07:15 +11:00 • committed by Joel Challis
parent 7874f297b3
commit 9ea9806d67
5 changed files with 57 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/contributing.md
View file

@ -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.