diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-04-17 14:08:45 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2020-04-17 14:08:45 +0000 |
| commit | aedd7f485397b322fc88c60241fa1e5e684fd2b4 (patch) | |
| tree | 2727053dbe2b8585430e20d779a2b25c9bae0d2b /docs/gen/layout.moon | |
| parent | remove defunct alv-copilot.bat (diff) | |
| download | alive-aedd7f485397b322fc88c60241fa1e5e684fd2b4.tar.gz alive-aedd7f485397b322fc88c60241fa1e5e684fd2b4.zip | |
move extra/ to docs/gen/ and split up
Diffstat (limited to 'docs/gen/layout.moon')
| -rw-r--r-- | docs/gen/layout.moon | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/docs/gen/layout.moon b/docs/gen/layout.moon new file mode 100644 index 0000000..084807e --- /dev/null +++ b/docs/gen/layout.moon @@ -0,0 +1,149 @@ +version = require 'alv.version' +dom = require 'docs.gen.dom' +import compile from require 'discount' + +render_meta = (meta) -> + import p, code from dom + contents = {} + if meta.examples + -- table.insert contents, h4 'signature' + examples = p table.concat [code e for e in *meta.examples], ' ' + table.insert contents, examples + if meta.description + description = compile meta.description\match '^\n*(.+)\n*$' + table.insert contents, description.body + + contents + +-- render an ALV Value to a HTML string +render = (name, value, prefix=nil, index=false) -> + import div, label, code, ul, li, i, a, pre from dom + + id = if prefix then "#{prefix}/#{name}" else name + type = i value.type + assert value.meta, "#{id} doesn't have any metadata!" + summary = assert value.meta.summary, "#{id} doesn't have a summary!" + + if index + div { + label (a (code name), href: "##{id}"), ' (', type, '):  – ' + summary + } + else + content = switch value.type + when 'scope' + ul for k, result in opairs value!.values + li render k, result.value, id + else + render_meta value.meta + + content.class = 'nest' + div { + :id, class: 'def' + label (a (code name), href: "##{id}"), ' (', type, '):  – ' + summary + div content + } + +-- generate a relative link +abs = (page) -> + if BASE + "#{BASE}#{page}" + else + assert OUT, "OUT needs to be set" + relative = assert (OUT\match '^docs/(.*)'), "unexpected output path" + _, depth = relative\gsub '/', '/' + up = string.rep '../', depth + "#{up}#{page}" + +-- generate a link to a reference entry +-- entry is one of +-- builtin-name; mod.name/name; mod.name +link = (ref) -> + return version.web if ref == '*web*' + return version.repo if ref == '*repo*' + return version.release if ref == '*release*' + + mod, sym = ref\match '^(.+)/(.*)$' + abs "reference/#{mod or 'index'}.html##{sym or ref}" + +-- link to a reference +r = (text, ref) -> + import a, code from dom + href = link ref or text + if ref + a text, :href + else + text = text\gsub '/$', '' + escape = ESCAPE or (i) -> i + a (code escape text), :href + +-- substitute markdown-style reference links +autoref = (str) -> + str = str\gsub '%[([^%]]-)%]%[%]', r + str = str\gsub '%[([^%]]-)%]%[:(.-):%]', r + str + +aopts = (href, pat) -> + { + href: abs href + class: if OUT\match "^docs/#{pat}" then 'active' + } + +-- layout and write a doc page +-- opts: +-- - preamble +-- - title +-- - style +-- - body (str or table) +layout = (opts) -> + import header, footer, nav, div, span, b, code, a, article from dom + + head = header nav { + span { + b 'alive' + ' ' + a (code version.tag), href: version.release + ' documentation' + } + div class: 'grow' + a 'home', aopts 'index.html', 'index.html$' + a 'getting started', aopts 'guide.html', 'guide.html$' + a 'reference', aopts 'reference/index.html', 'reference' + a 'internals', aopts 'internals/index.html', 'ldoc' + } + body = article opts.body + title = if opts.title + "#{opts.title} - alive" + else + "alive documentation" + foot = footer div { + 'alive ' + a (code version.tag), href: version.release + ', generated ' + os.date '!%Y-%m-%d %T' + } + + "#{opts.preamble or ''} +<!DOCTYPE html> +<html> + <head> + <meta charset=\"UTF-8\"> + <meta name=\"viewport\" content=\"width=640\"> + + <title>#{title}</title> + <link rel=\"stylesheet\" href=\"#{opts.style or abs 'style.css'}\"> + </head> + <body> + #{head} + #{body} + #{foot} + </body> +</html>" + + +{ + :autoref + :render + :layout +} |