aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md12
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 {
101}; 101};
102``` 102```
103 103
104### Previewing the Documentation
105
106Before 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:
107
108 ./bin/qmk docs
109
110or if you only have Python 3 installed:
111
112 python3 -m http.server 8936
113
114and navigating to `http://localhost:8936/`.
115
104## Keymaps 116## Keymaps
105 117
106Most 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. 118Most 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.