docs

package module

v0.0.0-...-a925bf1 Latest Latest Go to latest Published: Nov 10, 2025 License: MIT Imports: 13 Imported by: 0

Details

This section is empty.

This section is empty.

func DetectBrowser() string

DetectBrowser is exported for testing

type Client struct {
	// contains filtered or unexported fields
}

Client manages MkDocs container operations

func NewClient() (*Client, error)

NewClient creates a new docs client

func (c *Client) Close()

Close closes the Docker client connection

func (c *Client) IsRunning() (bool, *ContainerInfo, error)

IsRunning checks if the MkDocs container is already running

func (c *Client) OpenBrowser(url string) error

OpenBrowser opens the default web browser to the given URL

func (c *Client) StartContainer(port int) (*ContainerInfo, error)

StartContainer starts the MkDocs container

func (c *Client) StopContainer() error

StopContainer stops the MkDocs container

func (c *Client) StreamLogs() error

StreamLogs streams container logs to stdout

type ContainerInfo struct {
	Name string
	URL  string
	Port int
}

ContainerInfo contains information about the running MkDocs container