Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Development documentation (dev:main) — content may differ from any release.
httk-serve dev:main documentation
httk-serve dev:main documentation
  • Web guide
    • Widgets
    • Apache Deployment (ASGI)
    • Nginx Deployment (ASGI)
    • Migration: Legacy Templates to Jinja2
    • Site Template Repository
    • How It Works
  • OPTIMADE guide
    • Serving entry providers
    • Reading a remote OPTIMADE service
    • Examples
      • A small OPTIMADE demo server over an in-memory dataset.
      • Standing up a backend from plain dict rows, without writing a provider
      • A minimal OPTIMADE server fed by an httk-core entry provider.
      • Walking a live OPTIMADE API in-process, without binding a port
    • How it works
    • Walking an OPTIMADE API in-process
  • Reference
    • httk.serve.web
      • httk.serve.web.api
      • httk.serve.web.cli
      • httk.serve.web.compat
      • httk.serve.web.engine
        • httk.serve.web.engine.discovery
        • httk.serve.web.engine.site_engine
      • httk.serve.web.functions
        • httk.serve.web.functions.python_module
      • httk.serve.web.model
        • httk.serve.web.model.config
        • httk.serve.web.model.errors
        • httk.serve.web.model.page
        • httk.serve.web.model.request
      • httk.serve.web.providers
      • httk.serve.web.publishing
        • httk.serve.web.publishing.static
      • httk.serve.web.renderers
        • httk.serve.web.renderers.base
        • httk.serve.web.renderers.html
        • httk.serve.web.renderers.httkweb_compat
        • httk.serve.web.renderers.markdown
        • httk.serve.web.renderers.rst
      • httk.serve.web.resources
      • httk.serve.web.runtime
        • httk.serve.web.runtime.asgi
        • httk.serve.web.runtime.devserver
      • httk.serve.web.templating
        • httk.serve.web.templating.base
        • httk.serve.web.templating.httk_compat
        • httk.serve.web.templating.jinja2_engine
      • httk.serve.web.widgets
        • httk.serve.web.widgets.assets
        • httk.serve.web.widgets.core
        • httk.serve.web.widgets.extraction
        • httk.serve.web.widgets.loader
        • httk.serve.web.widgets.optimade_table
        • httk.serve.web.widgets.table
    • httk.serve.optimade
      • httk.serve.optimade.api
      • httk.serve.optimade.backend
        • httk.serve.optimade.backend.adapter
        • httk.serve.optimade.backend.execution
        • httk.serve.optimade.backend.handlers
        • httk.serve.optimade.backend.memory_store
        • httk.serve.optimade.backend.partial
        • httk.serve.optimade.backend.protocols
        • httk.serve.optimade.backend.providers
        • httk.serve.optimade.backend.translation
      • httk.serve.optimade.client
      • httk.serve.optimade.endpoints
        • httk.serve.optimade.endpoints.entries
        • httk.serve.optimade.endpoints.error
        • httk.serve.optimade.endpoints.info
        • httk.serve.optimade.endpoints.meta
        • httk.serve.optimade.endpoints.partial_data
      • httk.serve.optimade.engine
        • httk.serve.optimade.engine.processing
        • httk.serve.optimade.engine.validate
      • httk.serve.optimade.filter
      • httk.serve.optimade.model
        • httk.serve.optimade.model.config
        • httk.serve.optimade.model.errors
        • httk.serve.optimade.model.request
        • httk.serve.optimade.model.results
        • httk.serve.optimade.model.versions
      • httk.serve.optimade.remote_query
      • httk.serve.optimade.runtime
        • httk.serve.optimade.runtime.asgi
        • httk.serve.optimade.runtime.devserver
      • httk.serve.optimade.schema
        • httk.serve.optimade.schema.served
        • httk.serve.optimade.schema.trajectories
  • API Reference
    • httk.serve
      • httk.serve.optimade
        • httk.serve.optimade.api
        • httk.serve.optimade.backend
          • httk.serve.optimade.backend.adapter
          • httk.serve.optimade.backend.execution
          • httk.serve.optimade.backend.handlers
          • httk.serve.optimade.backend.memory_store
          • httk.serve.optimade.backend.partial
          • httk.serve.optimade.backend.protocols
          • httk.serve.optimade.backend.providers
          • httk.serve.optimade.backend.translation
        • httk.serve.optimade.client
        • httk.serve.optimade.endpoints
          • httk.serve.optimade.endpoints.entries
          • httk.serve.optimade.endpoints.error
          • httk.serve.optimade.endpoints.info
          • httk.serve.optimade.endpoints.meta
          • httk.serve.optimade.endpoints.partial_data
        • httk.serve.optimade.engine
          • httk.serve.optimade.engine.processing
          • httk.serve.optimade.engine.validate
        • httk.serve.optimade.filter
        • httk.serve.optimade.model
          • httk.serve.optimade.model.config
          • httk.serve.optimade.model.errors
          • httk.serve.optimade.model.request
          • httk.serve.optimade.model.results
          • httk.serve.optimade.model.versions
        • httk.serve.optimade.remote_query
        • httk.serve.optimade.runtime
          • httk.serve.optimade.runtime.asgi
          • httk.serve.optimade.runtime.devserver
        • httk.serve.optimade.schema
          • httk.serve.optimade.schema.served
          • httk.serve.optimade.schema.trajectories
      • httk.serve.web
        • httk.serve.web.api
        • httk.serve.web.cli
        • httk.serve.web.compat
        • httk.serve.web.engine
          • httk.serve.web.engine.discovery
          • httk.serve.web.engine.site_engine
        • httk.serve.web.functions
          • httk.serve.web.functions.python_module
        • httk.serve.web.model
          • httk.serve.web.model.config
          • httk.serve.web.model.errors
          • httk.serve.web.model.page
          • httk.serve.web.model.request
        • httk.serve.web.providers
        • httk.serve.web.publishing
          • httk.serve.web.publishing.static
        • httk.serve.web.renderers
          • httk.serve.web.renderers.base
          • httk.serve.web.renderers.html
          • httk.serve.web.renderers.httkweb_compat
          • httk.serve.web.renderers.markdown
          • httk.serve.web.renderers.rst
        • httk.serve.web.resources
        • httk.serve.web.runtime
          • httk.serve.web.runtime.asgi
          • httk.serve.web.runtime.devserver
        • httk.serve.web.templating
          • httk.serve.web.templating.base
          • httk.serve.web.templating.httk_compat
          • httk.serve.web.templating.jinja2_engine
        • httk.serve.web.widgets
          • httk.serve.web.widgets.assets
          • httk.serve.web.widgets.core
          • httk.serve.web.widgets.extraction
          • httk.serve.web.widgets.loader
          • httk.serve.web.widgets.optimade_table
          • httk.serve.web.widgets.table
    • httk.registry.cli.serve
Back to top
View this page

httk.serve.web.renderers.markdown¶

Classes¶

MarkdownRenderer

Module Contents¶

class httk.serve.web.renderers.markdown.MarkdownRenderer[source]¶
render(source_path: pathlib.Path) → httk.serve.web.renderers.base.RenderResult[source]¶
Next
httk.serve.web.renderers.rst
Previous
httk.serve.web.renderers.httkweb_compat
Copyright © 2026, The httk-serve AUTHORS
Made with Sphinx and @pradyunsg's Furo
On this page
  • httk.serve.web.renderers.markdown
    • Classes
    • Module Contents
      • MarkdownRenderer
        • MarkdownRenderer.render()