mirror of https://github.com/gohugoio/hugo.git
98 lines
2.7 KiB
Go
98 lines
2.7 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package asciidoc converts Asciidoc to HTML using Asciidoc or Asciidoctor
|
|
// external binaries.
|
|
package asciidoc
|
|
|
|
import (
|
|
"os/exec"
|
|
|
|
"github.com/gohugoio/hugo/markup/internal"
|
|
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
)
|
|
|
|
// Provider is the package entry point.
|
|
var Provider converter.NewProvider = provider{}
|
|
|
|
type provider struct {
|
|
}
|
|
|
|
func (p provider) New(cfg converter.ProviderConfig) (converter.Provider, error) {
|
|
var n converter.NewConverter = func(ctx converter.DocumentContext) (converter.Converter, error) {
|
|
return &asciidocConverter{
|
|
ctx: ctx,
|
|
cfg: cfg,
|
|
}, nil
|
|
}
|
|
return n, nil
|
|
}
|
|
|
|
type asciidocConverter struct {
|
|
ctx converter.DocumentContext
|
|
cfg converter.ProviderConfig
|
|
}
|
|
|
|
func (a *asciidocConverter) Convert(ctx converter.RenderContext) (converter.Result, error) {
|
|
return converter.Bytes(a.getAsciidocContent(ctx.Src, a.ctx)), nil
|
|
}
|
|
|
|
// getAsciidocContent calls asciidoctor or asciidoc as an external helper
|
|
// to convert AsciiDoc content to HTML.
|
|
func (a *asciidocConverter) getAsciidocContent(src []byte, ctx converter.DocumentContext) []byte {
|
|
var isAsciidoctor bool
|
|
path := getAsciidoctorExecPath()
|
|
if path == "" {
|
|
path = getAsciidocExecPath()
|
|
if path == "" {
|
|
a.cfg.Logger.ERROR.Println("asciidoctor / asciidoc not found in $PATH: Please install.\n",
|
|
" Leaving AsciiDoc content unrendered.")
|
|
return src
|
|
}
|
|
} else {
|
|
isAsciidoctor = true
|
|
}
|
|
|
|
a.cfg.Logger.INFO.Println("Rendering", ctx.DocumentName, "with", path, "...")
|
|
args := []string{"--no-header-footer", "--safe"}
|
|
if isAsciidoctor {
|
|
// asciidoctor-specific arg to show stack traces on errors
|
|
args = append(args, "--trace")
|
|
}
|
|
args = append(args, "-")
|
|
return internal.ExternallyRenderContent(a.cfg, ctx, src, path, args)
|
|
}
|
|
|
|
func getAsciidocExecPath() string {
|
|
path, err := exec.LookPath("asciidoc")
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return path
|
|
}
|
|
|
|
func getAsciidoctorExecPath() string {
|
|
path, err := exec.LookPath("asciidoctor")
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return path
|
|
}
|
|
|
|
// Supports returns whether Asciidoc or Asciidoctor is installed on this computer.
|
|
func Supports() bool {
|
|
return (getAsciidoctorExecPath() != "" ||
|
|
getAsciidocExecPath() != "")
|
|
}
|