Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gemrest/germ

🦠 The Definitive Gemini Protocol Toolkit
https://github.com/gemrest/germ

converter gemini gemini-protocol lexer markdown parser

Last synced: 21 days ago
JSON representation

🦠 The Definitive Gemini Protocol Toolkit

Host: GitHub
URL: https://github.com/gemrest/germ
Owner: gemrest
License: gpl-3.0
Created: 2022-05-12T07:41:34.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-06-21T15:47:21.000Z (5 months ago)
Last Synced: 2024-06-27T12:56:20.088Z (5 months ago)
Topics: converter, gemini, gemini-protocol, lexer, markdown, parser
Language: Rust
Homepage: https://crates.io/crates/germ
Size: 175 KB
Stars: 9
Watchers: 0
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Germ

[![crates.io](https://img.shields.io/crates/v/germ.svg)](https://crates.io/crates/germ)

[![docs.rs](https://docs.rs/germ/badge.svg)](https://docs.rs/germ)

[![github.com](https://github.com/gemrest/germ/actions/workflows/check.yaml/badge.svg?branch=main)](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:

[![crates.io](https://img.shields.io/crates/v/germ.svg)](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.

## License

This project is licensed with the

[GNU General Public License v3.0](https://github.com/gemrest/germ/blob/main/LICENSE).