qmk docs
: Run docsify serve
if available (#15056)
This commit is contained in:
parent
c85109b108
commit
6437045166
2 changed files with 25 additions and 9 deletions
|
@ -373,6 +373,8 @@ qmk format-c -b branch_name
|
||||||
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
|
This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
|
||||||
Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
|
Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
|
||||||
|
|
||||||
|
This command runs `docsify serve` if `docsify-cli` is installed (which provides live reload), otherwise Python's builtin HTTP server module will be used.
|
||||||
|
|
||||||
**Usage**:
|
**Usage**:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
"""
|
"""
|
||||||
import http.server
|
import http.server
|
||||||
import os
|
import os
|
||||||
|
import shutil
|
||||||
import webbrowser
|
import webbrowser
|
||||||
|
|
||||||
from milc import cli
|
from milc import cli
|
||||||
|
@ -11,10 +12,23 @@ from milc import cli
|
||||||
@cli.argument('-b', '--browser', action='store_true', help='Open the docs in the default browser.')
|
@cli.argument('-b', '--browser', action='store_true', help='Open the docs in the default browser.')
|
||||||
@cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True)
|
@cli.subcommand('Run a local webserver for QMK documentation.', hidden=False if cli.config.user.developer else True)
|
||||||
def docs(cli):
|
def docs(cli):
|
||||||
"""Spin up a local HTTPServer instance for the QMK docs.
|
"""Spin up a local HTTP server for the QMK docs.
|
||||||
"""
|
"""
|
||||||
os.chdir('docs')
|
os.chdir('docs')
|
||||||
|
|
||||||
|
# If docsify-cli is installed, run that instead so we get live reload
|
||||||
|
if shutil.which('docsify'):
|
||||||
|
command = ['docsify', 'serve', '--port', f'{cli.config.docs.port}', '--open' if cli.config.docs.browser else '']
|
||||||
|
|
||||||
|
cli.log.info(f"Running {{fg_cyan}}{str.join(' ', command)}{{fg_reset}}")
|
||||||
|
cli.log.info("Press Control+C to exit.")
|
||||||
|
|
||||||
|
try:
|
||||||
|
cli.run(command, capture_output=False)
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
cli.log.info("Stopping HTTP server...")
|
||||||
|
else:
|
||||||
|
# Fall back to Python HTTPServer
|
||||||
with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd:
|
with http.server.HTTPServer(('', cli.config.docs.port), http.server.SimpleHTTPRequestHandler) as httpd:
|
||||||
cli.log.info(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/")
|
cli.log.info(f"Serving QMK docs at http://localhost:{cli.config.docs.port}/")
|
||||||
cli.log.info("Press Control+C to exit.")
|
cli.log.info("Press Control+C to exit.")
|
||||||
|
|
Loading…
Reference in a new issue