mirror of
https://github.com/unisonweb/unison.git
synced 2024-09-11 10:35:57 +03:00
0031542faf
This is for consistency with the `cmark` style. Now the blocks we still pretty-print ourselves will match the bulk of them that `cmark` produces.
198 lines
2.9 KiB
Markdown
198 lines
2.9 KiB
Markdown
``` unison
|
|
otherDoc : a -> Doc2
|
|
otherDoc _ = {{ yo }}
|
|
|
|
otherTerm : Nat
|
|
otherTerm = 99
|
|
|
|
fulldoc : Doc2
|
|
fulldoc =
|
|
use Nat +
|
|
{{
|
|
Heres some text with a
|
|
soft line break
|
|
|
|
hard line break
|
|
|
|
Here's a cool **BOLD** __italic__ ~~strikethrough~~ thing with an inline code block ''1 + 2''
|
|
|
|
# Heading
|
|
|
|
## Heading 2
|
|
|
|
Term Link: {otherTerm}
|
|
|
|
Type Link: {type Optional}
|
|
|
|
Term source:
|
|
|
|
@source{term}
|
|
|
|
Term signature:
|
|
|
|
@signature{term}
|
|
|
|
* List item
|
|
|
|
Inline code:
|
|
|
|
`` 1 + 2 ``
|
|
|
|
` "doesn't typecheck" + 1 `
|
|
|
|
[Link](https://unison-lang.org)
|
|
|
|
|
|
|
|
Horizontal rule
|
|
|
|
---
|
|
|
|
Video
|
|
|
|
{{
|
|
Special
|
|
(Embed
|
|
(Any (Video [MediaSource "test.mp4" None] [("poster", "test.png")])))
|
|
}}
|
|
|
|
Transclusion/evaluation:
|
|
|
|
{{ otherDoc (a -> Word a) }}
|
|
|
|
---
|
|
|
|
The following markdown features aren't supported by the Doc format yet, but maybe will someday
|
|
|
|
|
|
> Block quote
|
|
|
|
|
|
Table
|
|
|
|
| Header 1 | Header 2 |
|
|
| -------- | -------- |
|
|
| Cell 1 | Cell 2 |
|
|
|
|
|
|
Indented Code block
|
|
|
|
|
|
}}
|
|
```
|
|
|
|
``` ucm
|
|
scratch/main> debug.doc-to-markdown fulldoc
|
|
|
|
Heres some text with a soft line break
|
|
|
|
hard line break
|
|
|
|
Here's a cool **BOLD** _italic_ ~~strikethrough~~ thing with an inline code block `1 + 2`
|
|
|
|
# Heading
|
|
|
|
## Heading 2
|
|
|
|
Term Link: `otherTerm`
|
|
|
|
Type Link: `Optional`
|
|
|
|
Term source:
|
|
|
|
```unison
|
|
term : '{g} a -> Doc2.Term
|
|
term a = Term.Term (Any a)
|
|
```
|
|
|
|
|
|
|
|
Term signature:
|
|
|
|
```unison
|
|
term : '{g} a -> Doc2.Term
|
|
```
|
|
|
|
|
|
|
|
- List item
|
|
|
|
Inline code:
|
|
|
|
`1 Nat.+ 2`
|
|
|
|
` "doesn't typecheck" + 1 `
|
|
|
|
[Link](https://unison-lang.org)
|
|
|
|
|
|
|
|
Horizontal rule
|
|
|
|
---
|
|
|
|
Video
|
|
|
|
|
|
|
|
Transclusion/evaluation:
|
|
|
|
yo
|
|
|
|
|
|
|
|
---
|
|
|
|
The following markdown features aren't supported by the Doc format yet, but maybe will someday
|
|
|
|
> Block quote
|
|
|
|
Table
|
|
|
|
| Header 1 | Header 2 | | -------- | -------- | | Cell 1 | Cell 2 |
|
|
|
|
Indented Code block
|
|
|
|
|
|
|
|
|
|
```
|
|
You can add docs to a term or type with a top-level doc literal above the binding:
|
|
|
|
``` unison
|
|
{{ This is a term doc }}
|
|
myTerm = 10
|
|
|
|
-- Regression tests for https://github.com/unisonweb/unison/issues/4634
|
|
{{ This is a type doc }}
|
|
type MyType = MyType
|
|
|
|
{{ This is a unique type doc }}
|
|
unique type MyUniqueType = MyUniqueType
|
|
|
|
{{ This is a structural type doc }}
|
|
structural type MyStructuralType = MyStructuralType
|
|
```
|
|
|
|
``` ucm
|
|
|
|
Loading changes detected in scratch.u.
|
|
|
|
I found and typechecked these definitions in scratch.u. If you
|
|
do an `add` or `update`, here's how your codebase would
|
|
change:
|
|
|
|
⍟ These new definitions are ok to `add`:
|
|
|
|
structural type MyStructuralType
|
|
(also named builtin.Unit)
|
|
type MyType
|
|
type MyUniqueType
|
|
MyStructuralType.doc : Doc2
|
|
MyType.doc : Doc2
|
|
MyUniqueType.doc : Doc2
|
|
myTerm : Nat
|
|
myTerm.doc : Doc2
|
|
|
|
```
|