mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-05-03 07:59:31 -05:00
Gabe Ruttner
8e80faf2d6
* api changes * doc changes * move docs * generated * generate * pkg * backmerge main * revert to main * revert main * race? * remove go tests
29 lines
663 B
Markdown
29 lines
663 B
Markdown
## Hatchet Examples
|
|
|
|
### Contributing
|
|
These examples are generated from SDK source where they include, to contribute updates to these docs please make these changes in the sdk source:
|
|
|
|
- Typescript: ../sdks/typescript/src/v1/examples
|
|
- Python: ../sdks/python/examples
|
|
- Go: ../pkg/examples
|
|
|
|
#### Comment Markup
|
|
|
|
We use a special comment markup to generate code snips for our docs. Markups support single line comments in typescript/go `//` or python `#`.
|
|
|
|
##### Blocks
|
|
|
|
```
|
|
// > Block Title
|
|
BLOCK CONTENT
|
|
// !!
|
|
```
|
|
|
|
##### Highlights
|
|
```
|
|
HH-name 1 hello
|
|
hello world
|
|
```
|
|
|
|
Where 1 is the number of lines to highlight and hello are strings to specifically highlight.
|