infodoc

The Infodoc Parser

This Go module parses documents that comply with the Infodoc standard with Tula markup.

Spec

Since this is the first Infodoc parser/renderer, specifications are included to write your own. See spec.md for info. If you need to clarify something, feel free to reach out!

Note

The HTML renderer included with this project renders sections as <section> instead of <p> because using <p> had issues, most notably that <p> self-closes after the first element if it is a block (for example, <p><h1>title</h1> text</p> becomes <p><h1>title</h1></p> text</p>.) This may be semantically incorrect, but it is syntactically correct, which is more important in my opinion.

Example

my-file.idoc

#idoc
title: My title
summary: My summary
---
[b bold text] [i italic text] [b [i both]]

main.go

package main

import (
    "os"
    "fmt"
    "codeberg.org/midna/infodoc"
)

func main() {
    content, err := os.ReadFile("./my-file.idoc")
    if err != nil {
       panic(err)
    }
    // parsing a document looks like this:
    document := infodoc.Parse(string(content))
    // metadata is a map of strings corresponding to strings (map[string]string)
    fmt.Printf("Document title:     %s\n", document.Metadata["title"])
    fmt.Printf("Document summary:   %s\n", document.Metadata["summary"])
    // you can render the tula markup to HTML like this:
    err = os.WriteFile("my-file.html", []byte(infodoc.RenderHtml(document)), 0644)
    if err != nil {
        panic(err)
    } else {
        println("Wrote my-file.html!")
    }
}

Output

stdout

Document title:     My title
Document summary:   My summary
Wrote my-file.html!

my-file.html

<section><b>bold text</b> <i>italic text</i> <b><i>both</i></b></section>