1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
# Germ
[](https://crates.io/crates/germ)
[](https://docs.rs/germ)
[](https://github.com/gemrest/germ/actions/workflows/check.yaml)
The Ultimate Gemini Toolkit
Germ is a toolkit for the Gemini protocol which aims to have a little something
for everyone. At the moment, Germ has **ZERO** dependencies (unless you use the
`request` feature), and Germ will continue to try its hardest to have as few
dependencies as possible.
## Features
- AST builder to easily construct and manipulate AST trees from raw Gemtext
- Converters to easily convert from Gemtext to markup formats such as HTML or
Markdown
- Blocking and non-blocking request suite
- Structured meta section manipulation
- And more!
Check out the rest of the features in the Features section under Usage
## Usage
Current version:
[](https://crates.io/crates/germ)
```toml
# Cargo.toml
[dependencies]
# To enable only the base (default) features: ast, convert, meta, request
# germ = "*" # Use current version show above!
# To enable only certain features
[dependencies.germ]
version = "*" # Use current version show above!
default-features = false
features = ["ast"] # Enable the features you would like to use!
```
### Features
| Feature | Description |
| ---------- | --------------------------------------------------------------------- |
| `default` | `ast`, `convert`, `meta`, `request` |
| `ast` | Construct AST trees from raw Gemtext |
| `blocking` | Blocking equivalent of `request` |
| `convert` | Convert Gemtext to markup formats such as HTML or Markdown |
| `request` | Make Gemini requests, get sane, structured results |
| `meta` | Structure-ise a Gemini response's meta section |
| `macros` | Macros to aid with various Germ-related functionalities |
| `quick` | Tiny functions to create valid Gemtext elements from structured input |
### Examples
Thoroughly commented examples can be found within the
[`examples/`](https://github.com/gemrest/germ/tree/main/examples) directory.
Examples can be run by name using the example just task.
(e.g., `just example ast_to_gemtext`)
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or
[MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
|