diff options
| -rw-r--r-- | docs/cli_commands.md | 2 | ||||
| -rw-r--r-- | lib/python/qmk/cli/docs.py | 32 | 
2 files changed, 25 insertions, 9 deletions
| diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8fa7ad41dc..e498f3b22e 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -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.  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**:  ``` diff --git a/lib/python/qmk/cli/docs.py b/lib/python/qmk/cli/docs.py index d8f9b045a1..c24b914bc1 100644 --- a/lib/python/qmk/cli/docs.py +++ b/lib/python/qmk/cli/docs.py @@ -2,6 +2,7 @@  """  import http.server  import os +import shutil  import webbrowser  from milc import cli @@ -11,20 +12,33 @@ from milc import cli  @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)  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') -    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("Press Control+C to exit.") +    # 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 ''] -        if cli.config.docs.browser: -            webbrowser.open(f'http://localhost:{cli.config.docs.port}') +        cli.log.info(f"Running {{fg_cyan}}{str.join(' ', command)}{{fg_reset}}") +        cli.log.info("Press Control+C to exit.")          try: -            httpd.serve_forever() +            cli.run(command, capture_output=False)          except KeyboardInterrupt:              cli.log.info("Stopping HTTP server...") -        finally: -            httpd.shutdown() +    else: +        # Fall back to Python HTTPServer +        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("Press Control+C to exit.") + +            if cli.config.docs.browser: +                webbrowser.open(f'http://localhost:{cli.config.docs.port}') + +            try: +                httpd.serve_forever() +            except KeyboardInterrupt: +                cli.log.info("Stopping HTTP server...") +            finally: +                httpd.shutdown() | 
