gemrendr 0.4.0

Turns Gemtext into idiomatic HTML
Documentation 
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Structures that deal with deserialized Gemtext documents.

// gemrendr   Turns Gemtext into idiomatic HTML.
// Copyright (C) 2026  AverageHelper
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use alloc::{string::String, vec::Vec};

/// Represents a Gemtext document.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Document {
	/// The blocks that comprise the Gemtext document.
	pub contents: Vec<GemtextContentBlock>,
}

impl Document {
	/// Parses the given text document as Gemtext.
	pub fn parse_from_gemtext(document: &str) -> Self {
		document.parse().expect("infallible")
	}
}

/// A block of Gemtext content.
///
/// Each case generally corresponds to a text line (e.g. `Text`
/// or `Link`) but may sometimes consist of multiple lines
/// (e.g. `List` or `Pre`).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum GemtextContentBlock {
	/// A Gemtext text line.
	Text {
		/// The text.
		content: String,
	},

	/// A Gemtext link line.
	Link {
		/// The URI where the link points.
		target: String,

		/// The user-facing text of the link, if given.
		label: Option<String>,
	},

	/// A Gemtext heading line.
	Heading {
		/// The heading level.
		level: HeadingLevel,

		/// The heading text.
		content: String,
	},

	/// A Gemtext list block.
	List {
		/// Elements of the list.
		items: Vec<String>,
	},

	/// A Gemtext quote line.
	Quote {
		/// The text being quoted.
		content: String,
	},

	/// A Gemtext preformatted text block.
	Pre {
		/// Text that describes the pre-formatted text block.
		alt_text: Option<String>,

		/// The content of the pre-formatted text block.
		content: String,
	},

	/// Text that clients should ignore, i.e. a comment.
	Ignored {
		/// The text which clients should ignore, such as a comment.
		content: String,
	},
}

/// One of the three levels of a Gemtext heading.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum HeadingLevel {
	/// Represents a top-level heading.
	One,

	/// Represents a subheading.
	Two,

	/// Represents a sub-subheading.
	Three,
}