Merge pull request #4210 from urbit/m/file-surfer-docs

file-server: inline docs for actions
This commit is contained in:
matildepark 2021-01-07 19:46:04 -05:00 committed by GitHub
commit ef289cf282
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,10 +1,29 @@
/- glob /- glob
|% |%
+$ action +$ action
$% [%serve-dir url-base=path clay-base=path public=? spa=?] $% :: %serve-dir: from clay directory
::
:: url-base site path to route from
:: clay-base clay path to route to
:: public if false, require login
:: spa if true, `404` becomes `clay-base/index.html`
::
[%serve-dir url-base=path clay-base=path public=? spa=?]
:: %serve-glob: from glob blobs
::
:: url-base site path to route from
:: glob blobs
:: public if false, require login
::
[%serve-glob url-base=path =glob:glob public=?] [%serve-glob url-base=path =glob:glob public=?]
:: %unserve-dir: remove binding on url-base
::
[%unserve-dir url-base=path] [%unserve-dir url-base=path]
:: %toggle-permission: toggle public flag on url-base
::
[%toggle-permission url-base=path] [%toggle-permission url-base=path]
:: %set-landscape-homepage-prefix: serve landscape at / or /term
::
[%set-landscape-homepage-prefix prefix=(unit term)] [%set-landscape-homepage-prefix prefix=(unit term)]
== ==
:: ::