Fs
FsLiveDocs
  • Home
  • API
  • GitHub
  • 0.6.1
    • 0.6.2
    • 0.6.1
    • 0.6.0
    • 0.5.0
    • 0.4.1
    • 0.4.0
    • 0.3.8
    • 0.3.7
    • 0.3.6
    • 0.3.5
    • 0.3.4
    • 0.3.3
    • 0.3.2
    • 0.3.1
    • 0.3.0
  • light
  • dark
  • cupcake
  • dracula
  • emerald
  • corporate
  • retro
  • cyberpunk

API Reference

FsLiveDocs.Annotations

DocScenarioAttribute

Type

# DocScenarioAttribute `DocScenarioAttribute` marks deterministic setup code for a named XML documentation example.

Acme.Docs

Docs

Namespace

# Acme.Docs sample `Acme.Docs` is a tiny library used to show what FsLiveDocs can do.

CustomerContext

Module

# CustomerContext `CustomerContext` demonstrates deterministic setup for an XML documentation example.

Order

Module

# Order functions The `Order` module contains the operations for the sample `Order` record.

Order

Record

# Order `Order` is the sample's basic domain type.

On This Page

    Overview

    • Home
    • API Reference

    Docs

    • Why FsLiveDocs
    • Set up your repository
    • Guides
      • Write API and guide pages
      • Author and test examples
      • Add semantic code tooltips
      • Transclude source and examples
      • Link to API symbols
      • Configure pages with front matter
      • Configure navigation and branding
      • Verify documentation in CI
      • Capture and publish releases
    • Advanced authoring
    • Command reference
    • Reference
    • Reference
      • Repository and discovery
      • Verification
      • API and semantic extraction
      • Release capsules
      • Release history
      • Security and failures
    • How this site dogfoods FsLiveDocs

    API Reference

    • FsLiveDocs.Annotations
      • DocScenarioAttribute
    • Acme.Docs
      • CustomerContext
      • Order
      • Order