From 5f827342b522262487e8beb06948faef2c1cfa58 Mon Sep 17 00:00:00 2001 From: s-ol Date: Sat, 2 Jan 2021 23:59:19 +0100 Subject: show meta.description field in module docs --- docs/gen/module | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/gen/module b/docs/gen/module index 7b94dff..450bd61 100755 --- a/docs/gen/module +++ b/docs/gen/module @@ -1,9 +1,10 @@ #!/usr/bin/env moon import Constant from require 'alv' -import render, render_meta, layout, subnav from require 'docs.gen.layout' +import opairs from require 'alv.util' +import render, render_meta, layout, autoref, subnav from require 'docs.gen.layout' import h2, h3, p, ul, li, code from require 'docs.gen.dom' import get_module from require 'docs.gen.shim' -import opairs from require 'alv.util' +import compile from require 'discount' export OUT @@ -23,12 +24,22 @@ name or= module module = get_module module raw = module! +get_description = (module) -> + m = module.meta + return '' unless m + + buf = p m.summary + if m.description + buf ..= (compile autoref m.description).body + + buf + spit OUT, layout title: "#{name} module reference" body: table.concat { subnav [a for a in *arg[4,]] h2 (code name), ' module reference' - p if m = module.meta then m.summary else '' + get_description module h3 'index' ul for key, node in opairs raw.values li render key, node.result, nil, true -- cgit v1.2.3