api

package

v0.0.0-...-a8d0bc3 Latest Latest Go to latest Published: Mar 24, 2016 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Account struct {
	Client *client.Client
}

func (a *Account) Get() (models.Account, error)

Get returns a books details for a given "bookId" (for example "gitbookio/javascript")

type Author struct {
	Client *client.Client
}

func (a *Author) Get(username string) (models.Author, error)

type Book struct {
	Client *client.Client
}

func (b *Book) Get(bookId string) (models.Book, error)

Get returns a books details for a given "bookId" (for example "gitbookio/javascript")

type Books struct {
	Client *client.Client
}

func (b *Books) List() ([]models.Book, error)

type BuildOptions models.Build

BuildOptions are optional data passed along when doing a build (e.g: branch, message, author, ...)

type Builds struct {
	Client *client.Client
}

func (b *Builds) Build(bookId, version, path string, opts BuildOptions) error

Build should only be used by internal clients, Publish by others Build starts a build and will not update the backing git repository

func (b *Builds) BuildFolder(bookId, version, path string, opts BuildOptions) error

PublishFolder packages a folder as tar.gz and uploads it to gitbook.io

func (b *Builds) BuildGit(bookId, version, path, ref string, opts BuildOptions) error

PublishGit packages a git repo as tar.gz and uploads it to gitbook.io

func (b *Builds) BuildTarGz(bookId, version, path string, opts BuildOptions) error

PublishTarGz publishes a book based on a tar.gz file

func (b *Builds) PublishBuildStream(bookId, version string, reader io.Reader, opts BuildOptions) error