| License | BSD-3-Clause |
|---|---|
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Swarm.Doc.Schema.Render
Description
Render a markdown document fragment from the Scenario JSON schema files.
Synopsis
- scenariosDir :: FilePath
- docFragmentsDir :: FilePath
- schemasDir :: FilePath
- schemaExtension :: String
- propertyColumnHeadings :: [Text]
- listColumnHeadings :: [Text]
- makeTitleMap :: [SchemaData] -> Map SchemaIdReference Text
- makePandocTable :: Map SchemaIdReference Text -> SchemaData -> Pandoc
- genPropsRow :: Bool -> Map SchemaIdReference Text -> (Text, SwarmSchema) -> [Blocks]
- makePropsTable :: Bool -> [Text] -> Map SchemaIdReference Text -> Map Text SwarmSchema -> Blocks
- type FileStemAndExtension = (FilePath, String)
- recombineExtension :: FileStemAndExtension -> FilePath
- genMarkdown :: [SchemaData] -> Either Text Text
- parseSchemaFile :: FileStemAndExtension -> IO (Either Text ToplevelSchema)
- loadFooterContent :: (FilePath, ToplevelSchema) -> IO SchemaData
- genScenarioSchemaDocs :: IO ()
- renderValue :: Value -> Text
- fragmentHref :: Map SchemaIdReference Text -> SchemaIdReference -> Text
- listToText :: Map SchemaIdReference Text -> SchemaType -> Inlines
- formatNumberCompact :: Scientific -> String
Documentation
listColumnHeadings :: [Text] Source #
makeTitleMap :: [SchemaData] -> Map SchemaIdReference Text Source #
makePandocTable :: Map SchemaIdReference Text -> SchemaData -> Pandoc Source #
genPropsRow :: Bool -> Map SchemaIdReference Text -> (Text, SwarmSchema) -> [Blocks] Source #
makePropsTable :: Bool -> [Text] -> Map SchemaIdReference Text -> Map Text SwarmSchema -> Blocks Source #
type FileStemAndExtension = (FilePath, String) Source #
genMarkdown :: [SchemaData] -> Either Text Text Source #
loadFooterContent :: (FilePath, ToplevelSchema) -> IO SchemaData Source #
genScenarioSchemaDocs :: IO () Source #
renderValue :: Value -> Text Source #
fragmentHref :: Map SchemaIdReference Text -> SchemaIdReference -> Text Source #
listToText :: Map SchemaIdReference Text -> SchemaType -> Inlines Source #
formatNumberCompact :: Scientific -> String Source #
Strips trailing zeros and decimal point from a floating-point number when possible.
Obtained from here: https://stackoverflow.com/a/35980995/105137