|
| 1 | +package pandoc_config |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "strings" |
| 6 | +) |
| 7 | + |
| 8 | +// Config contains configuration settings for Pandoc. |
| 9 | +type Config struct { |
| 10 | + // Input format. Use the 'Extensions' field to specify extensions thereof. |
| 11 | + // Only specify the bare format here. Defaults to 'markdown' if empty. Invoke |
| 12 | + // "pandoc --list-input-formats" to see the list of supported input formats |
| 13 | + // including various Markdown dialects. |
| 14 | + InputFormat string |
| 15 | + |
| 16 | + // If true, the output format is HTML (i.e. "--to=html"). Otherwise the output |
| 17 | + // format is HTML5 (i.e. "--to=html5"). |
| 18 | + UseLegacyHtml bool |
| 19 | + |
| 20 | + // Equivalent to specifying "--mathjax". For compatibility, this option is |
| 21 | + // always true if none of the other math options are used. |
| 22 | + // See https://pandoc.org/MANUAL.html#math-rendering-in-html |
| 23 | + UseMathjax bool |
| 24 | + |
| 25 | + // Equivalent to specifying "--mathml". |
| 26 | + // See https://pandoc.org/MANUAL.html#math-rendering-in-html |
| 27 | + UseMathml bool |
| 28 | + |
| 29 | + // Equivalent to specifying "--webtex". |
| 30 | + // See https://pandoc.org/MANUAL.html#math-rendering-in-html. Uses the default |
| 31 | + // Webtex rendering URL. |
| 32 | + UseWebtex bool |
| 33 | + |
| 34 | + // Equivalent to specifying "--katex". |
| 35 | + // See https://pandoc.org/MANUAL.html#math-rendering-in-html |
| 36 | + UseKatex bool |
| 37 | + |
| 38 | + // List of filters to use. These translate to '--filter=' or '--lua-filter' |
| 39 | + // arguments to the pandoc invocation. The order of elements in `Filters` |
| 40 | + // is preserved when constructing the `pandoc` commandline. |
| 41 | + // |
| 42 | + // Use the prefix 'lua:' or the suffix '.lua' to indicate Lua filters. |
| 43 | + Filters []string |
| 44 | + |
| 45 | + // List of Pandoc Markdown extensions to use. No need to include default |
| 46 | + // extensions. Specifying ["foo", "bar"] is equivalent to specifying |
| 47 | + // --from=markdown+foo+bar on the pandoc commandline. |
| 48 | + Extensions []string |
| 49 | + |
| 50 | + // List of input format extensions to use. Specifying ["foo", "bar"] is |
| 51 | + // equivalent to specifying --from=markdown+foo+bar on the pandoc commandline |
| 52 | + // assuming InputFormat is "markdown". |
| 53 | + InputExtensions []string |
| 54 | + |
| 55 | + // List of output format extensions to use. Specifying ["foo", "bar"] is |
| 56 | + // equivalent to specifying --to=html5+foo+bar on the pandoc commandline, |
| 57 | + // assuming UseLegacyHTML is false. Invoke "pandoc --list-extensions=html5" to |
| 58 | + // or "pandoc --list-extensions=html5" to see the list of extensions that can |
| 59 | + // be specified here. |
| 60 | + OutputExtensions []string |
| 61 | + |
| 62 | + // Metadata. The dictionary keys and values are handled in the obvious way. |
| 63 | + Metadata map[string]interface{} |
| 64 | + |
| 65 | + // Extra commandline options passed to the pandoc invocation. These options |
| 66 | + // are appended to the commandline after the format and filter options. |
| 67 | + // Arguments are passed in literally. Hence must have the "--" or "-" prefix |
| 68 | + // where applicable. |
| 69 | + ExtraArgs []string |
| 70 | +} |
| 71 | + |
| 72 | +var Default = Config{ |
| 73 | + InputFormat:"markdown", |
| 74 | + UseLegacyHtml:false, |
| 75 | + UseMathjax:true |
| 76 | +} |
| 77 | + |
| 78 | +func (c *Config) getInputArg() string { |
| 79 | + var b strings.Builder |
| 80 | + b.WriteString("--from=") |
| 81 | + if len(c.InputFormat) > 0 { |
| 82 | + b.WriteString(c.InputFormat) |
| 83 | + } else { |
| 84 | + b.WriteString("markdown") |
| 85 | + } |
| 86 | + |
| 87 | + for _, extension := range c.InputExtensions { |
| 88 | + b.WriteString("+") |
| 89 | + b.WriteString(extension) |
| 90 | + } |
| 91 | + return b.String() |
| 92 | +} |
| 93 | + |
| 94 | +func (c *Config) getOutputArg() string { |
| 95 | + var b strings.Builder |
| 96 | + b.WriteString("--to=") |
| 97 | + if c.UseLegacyHtml { |
| 98 | + b.WriteString("html") |
| 99 | + } else { |
| 100 | + b.WriteString("html5") |
| 101 | + } |
| 102 | + |
| 103 | + for _, extension := range c.OutputExtensions { |
| 104 | + b.WriteString("+") |
| 105 | + b.WriteString(extension) |
| 106 | + } |
| 107 | + return b.String() |
| 108 | +} |
| 109 | + |
| 110 | +func (c *Config) getMathRenderingArg() string { |
| 111 | + switch { |
| 112 | + case c.UseMathml: |
| 113 | + return "--mathml" |
| 114 | + case c.UseWebtex: |
| 115 | + return "--webtex" |
| 116 | + case c.UseKatex: |
| 117 | + return "--katex" |
| 118 | + default: |
| 119 | + return "--mathjax" |
| 120 | + } |
| 121 | +} |
| 122 | + |
| 123 | +func (c *Config) getMetadataArgs() []string { |
| 124 | + var args []string |
| 125 | + for k, iv := range c.Metadata { |
| 126 | + var v string |
| 127 | + if sv, ok := iv.(string); ok { |
| 128 | + v = sv |
| 129 | + } else if sv, ok := iv.(fmt.Stringer); ok { |
| 130 | + v = sv.String() |
| 131 | + } else { |
| 132 | + v = fmt.Sprintf("%v", iv) |
| 133 | + } |
| 134 | + args = append(args, fmt.Sprintf("-M%s=%s", k, v)) |
| 135 | + } |
| 136 | + return args |
| 137 | +} |
| 138 | + |
| 139 | +func (c *Config) getFilterArgs() []string { |
| 140 | + var args []string |
| 141 | + for _, filterPath := range c.Filters { |
| 142 | + if strings.HasPrefix(filterPath, "lua:") || strings.HasSuffix(filterPath, ".lua") { |
| 143 | + args = append(args, fmt.Sprintf("--lua-filter=%s", strings.TrimPrefix(filterPath, "lua:"))) |
| 144 | + } else { |
| 145 | + args = append(args, fmt.Sprintf("--filter=%s", filterPath)) |
| 146 | + } |
| 147 | + } |
| 148 | + return args |
| 149 | +} |
| 150 | + |
| 151 | +// AsPandocArguments returns a list of strings that can be used as arguments to |
| 152 | +// a "pandoc" invocation. All the settings contained in Config are represented |
| 153 | +// in the returned list of arguments. |
| 154 | +func (c *Config) AsPandocArguments() []string { |
| 155 | + args := []string{ |
| 156 | + c.getInputArg(), |
| 157 | + c.getOutputArg(), |
| 158 | + c.getMathRenderingArg()} |
| 159 | + |
| 160 | + args = append(args, c.getMetadataArgs()...) |
| 161 | + args = append(args, c.getFilterArgs()...) |
| 162 | + args = append(args, c.ExtraArgs...) |
| 163 | + |
| 164 | + return args |
| 165 | +} |
0 commit comments