Categorygithub.com/monopole/mdrip/v2internalloader
package
2.0.5
Repository: https://github.com/monopole/mdrip.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
15
Files
883 SLOC

# README

Loader

This package loads markdown files from a file system into memory, retaining the file system tree structure.

ldr := loader.NewFsLoader(afero.NewOsFs())
folder, err := ldr.LoadTrees(args)
if err != nil {
  return err
}
visitor.VisitFolder(folder)

LoadTrees returns an instance of MyFolder.

MyFolder holds slices of MyFile and MyFolder.

Each of these is a tree node with a Name, a full Path, and a visitor acceptance method.

# Packages

No description provided by the author

# Functions

CloneAndLoadRepo clones a repo locally and loads it.
No description provided by the author
DirBase behavior: path | dir | base -------------------+------------+----------- {empty string} | .
No description provided by the author
No description provided by the author
No description provided by the author
InNotIgnorableFolder returns an error if FileInfo happens to be a dot directory (.git, .config, etc.) TODO: write something that honors a local .gitignore.
IsMarkDownFile passes markdown files.
IsOrderingFile returns true if the file appears to be an "ordering" file specifying which files should come first in a directory.
IsWhatever passes everything.
LoadOrderFile returns a list of names specify file name order priority.
New returns a file system (FS) loader with default filters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewTutorialTxtPrinter makes a new TxtPrinter for the given writer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SkipLabel is used on blocks that should be skipped in some context.
SleepLabel indicates the author wants a sleep after the block in a test context where there is no natural human-caused pause.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

CodeBlock groups code from a FencedCodeBlock with a set of labels.
FsLoader navigates and reads a file system.
MyFile is named byte array.
MyFolder is a named group of files and folders.
MyTopFolder is a named group of files and folders.
TxtPrinter prints a tutorial as text.
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
TreeVisitor has the ability to visit the items specified in its methods.

# Type aliases

FilePath helps w/ type safety and readability.
FsFilter returns an error if conditions for a file or folder are not met.
Label is used to select code blocks, and group them into categories, e.g.
No description provided by the author