mkdocsrest_example.yaml

# REST API server related configuration options
server:
  # Host and port the REST API server should listen on
  host: "0.0.0.0"
  # Port the REST API server should listen on
  # (optional) defaults to 7413
  port: 7413
  # (optional) Basic authentication credentials
  basicAuth:
    # (optional) Username
    user: "mkdocsrest"
    # (optional) Password
    password: "mypassword"
  # (optional) Cross-origin resource sharing (CORS) configuration
  cors:
    # (optional) List of allowed origins
    allowedOrigins:
      - "https://wiki.mycompany.com"
    # (optional) List of allowed methods
    allowedMethods:
      - HEAD
      - GET
      - PUT
      - POST
      - DELETE

# MkDocs related configuration options
mkdocs:
  # Path to the root of the mkdocs project
  projectPath: "/home/markus/documents/Wiki"
  # (optional) Path to the mkdocs.yml file
  # defaults to "<projectPath>/mkdocs.yml"
  configFile: "/home/markus/documents/Wiki/mkdocs.yml"
  # (optional) Path to the directory containing the documents
  # defaults to "<projectPath>/docs"
  docsPath: "/home/markus/documents/Wiki/docs"
  # (optional) List of files and directories to exclude from the document tree
  blacklist:
    - "stylesheets"