package
0.2.0
Repository: https://github.com/robloxapi/rbxapiref.git
Documentation: pkg.go.dev

# README

GoDoc

documents

The documents package is used for locating and parsing Roblox API documentation files.

# Functions

FindGit returns the path to the git executable, or an empty string if it is not available.
GitRead attempts to read the most recently committed content of a file.
MarkdownFileHandler is a FileHandler that parses a markdown file.
NewDirectorySection returns a new DirectorySection from the given path.
NewMarkdownSection creates a new MarkdownSection from an ast.Document.

# Structs

DirectorySection represents a directory in a file system.
MarkdownHandler has a configurable FileHandler that parses a markdown file.
MarkdownSection represents a portion of a markdown document.

# Interfaces

Countable extends a Section by representing a document with countable content.
Headingable extends a Section by representing an outline with traversable headings.
Linkable extends a Section by representing a document with traversable reference links.
Section represents a queryable portion of a resource.

# Type aliases

FileHandler hooks into a directory query, transforming a file within the directory into a Section.