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