package documentation: gemini, gemtext, contrib
continuous-integration/drone/tag Build is passing Details
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tjpcc 2023-01-19 10:12:30 -07:00
parent f569df6ead
commit 7d8fd81278
3 changed files with 21 additions and 0 deletions

4
contrib/doc.go Normal file
View File

@ -0,0 +1,4 @@
/*
Contrib contains sub-packages with specific functionality for small web servers.
*/
package contrib

10
gemini/doc.go Normal file
View File

@ -0,0 +1,10 @@
/*
The gemini package contains everything needed for building clients and servers on the gemini protocol.
There are server and client implementations, parsers, formatters, and constructors for gemini requests
and responses, and a utility for building a gemini-ready TLS configuration.
The gemtext subpackage is a library usefor for parsing and otherwise using gemtext documents, including
transforming them into a few other languages with overridable templates.
*/
package gemini

7
gemini/gemtext/doc.go Normal file
View File

@ -0,0 +1,7 @@
/*
The gemtext package contains a gemtext AST and parser.
Conversion sub-packages can convert this AST into other document types, and support
overridable templates.
*/
package gemtext