github.com/anakojm/hugo-katex@v0.0.0-20231023141351-42d6f5de9c0b/README.md (about) 1 # Install 2 3 ```bash 4 git clone https://github.com/anakojm/hugo-katex 5 cd hugo-katex/ 6 go build 7 ``` 8 9 Don't forget to enable it in `config.toml`: 10 ```toml 11 [markup.goldmark.katex] 12 enabled = true 13 warnings = false 14 ``` 15 16 And voilà, using the `hugo-katex` binary, `$\LaTeX$` and `$$\LaTeX$$` will get correctly rendered with the only need of the KaTeX [css file](https://cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.css). 17 18 Checkout the [README](https://github.com/gohugoio/hugo) of the author of this patch and of the parser for more informations. 19 20 None of these changes are from me, I just applied graemephi's patch on a more recent version of Hugo. 21 22 # Original Hugo Readme 23 [bep]: https://github.com/bep 24 [bugs]: https://github.com/gohugoio/hugo/issues?q=is%3Aopen+is%3Aissue+label%3ABug 25 [contributing]: CONTRIBUTING.md 26 [create a proposal]: https://github.com/gohugoio/hugo/issues/new?labels=Proposal%2C+NeedsTriage&template=feature_request.md 27 [documentation repository]: https://github.com/gohugoio/hugoDocs 28 [documentation]: https://gohugo.io/documentation 29 [dragonfly bsd, freebsd, netbsd, and openbsd]: https://gohugo.io/installation/bsd 30 [forum]: https://discourse.gohugo.io 31 [friends]: https://github.com/gohugoio/hugo/graphs/contributors 32 [go]: https://go.dev/ 33 [hugo modules]: https://gohugo.io/hugo-modules/ 34 [installation]: https://gohugo.io/installation 35 [issue queue]: https://github.com/gohugoio/hugo/issues 36 [linux]: https://gohugo.io/installation/linux 37 [macos]: https://gohugo.io/installation/macos 38 [prebuilt binary]: https://github.com/gohugoio/hugo/releases/latest 39 [requesting help]: https://discourse.gohugo.io/t/requesting-help/9132 40 [spf13]: https://github.com/spf13 41 [static site generator]: https://en.wikipedia.org/wiki/Static_site_generator 42 [support]: https://discourse.gohugo.io 43 [themes]: https://themes.gohugo.io/ 44 [twitter]: https://twitter.com/gohugoio 45 [website]: https://gohugo.io 46 [windows]: https://gohugo.io/installation/windows 47 48 <a href="https://gohugo.io/"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt="Hugo" width="565"></a> 49 50 A fast and flexible static site generator built with love by [bep], [spf13], and [friends] in [Go]. 51 52 --- 53 54 [![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://godoc.org/github.com/gohugoio/hugo) 55 [![Tests on Linux, MacOS and Windows](https://github.com/gohugoio/hugo/workflows/Test/badge.svg)](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest) 56 [![Go Report Card](https://goreportcard.com/badge/github.com/gohugoio/hugo)](https://goreportcard.com/report/github.com/gohugoio/hugo) 57 58 [Website] | [Installation] | [Documentation] | [Support] | [Contributing] | <a rel="me" href="https://fosstodon.org/@gohugoio">Mastodon</a> 59 60 ## Overview 61 62 Hugo is a [static site generator] written in [Go], optimized for speed and designed for flexibility. With its advanced templating system and fast asset pipelines, Hugo renders a complete site in seconds, often less. 63 64 Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create: 65 66 - Corporate, government, nonprofit, education, news, event, and project sites 67 - Documentation sites 68 - Image portfolios 69 - Landing pages 70 - Business, professional, and personal blogs 71 - Resumes and CVs 72 73 Use Hugo's embedded web server during development to instantly see changes to content, structure, behavior, and presentation. Then deploy the site to your host, or push changes to your Git provider for automated builds and deployment. 74 75 Hugo's fast asset pipelines include: 76 77 - CSS bundling – transpilation (Sass), tree shaking, minification, source maps, SRI hashing, and PostCSS integration 78 - JavaScript bundling – transpilation (TypeScript, JSX), tree shaking, minification, source maps, and SRI hashing 79 - Image processing – convert, resize, crop, rotate, adjust colors, apply filters, overlay text and images, and extract EXIF data 80 81 And with [Hugo Modules], you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories. 82 83 ## Sponsors 84 85 <p> </p> 86 <p float="left"> 87 <a href="https://www.linode.com/?utm_campaign=hugosponsor&utm_medium=banner&utm_source=hugogithub" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/linode-logo_standard_light_medium.png" width="200" alt="Linode"></a> 88 <a href="https://cloudcannon.com/hugo-cms/?utm_campaign=HugoSponsorship&utm_source=sponsor&utm_content=gohugo" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/cloudcannon-blue.svg" width="220" alt="CloudCannon"></a> 89 <p> </p> 90 91 ## Installation 92 93 Install Hugo from a [prebuilt binary], package manager, or package repository. Please see the installation instructions for your operating system: 94 95 - [macOS] 96 - [Linux] 97 - [Windows] 98 - [DragonFly BSD, FreeBSD, NetBSD, and OpenBSD] 99 100 ## Build from source 101 102 Hugo is available in two editions: standard and extended. With the extended edition you can: 103 104 - Encode to the WebP format when processing images. You can decode WebP images with either edition. 105 - Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler. 106 107 Prerequisites to build Hugo from source: 108 109 - Standard edition: Go 1.19 or later 110 - Extended edition: Go 1.19 or later, and GCC 111 112 Build the standard edition: 113 114 ```text 115 go install github.com/gohugoio/hugo@latest 116 ``` 117 118 Build the extended edition: 119 120 ```text 121 CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest 122 ``` 123 124 ## Documentation 125 126 Hugo's [documentation] includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples. 127 128 Please submit documentation issues and pull requests to the [documentation repository]. 129 130 ## Support 131 132 Please **do not use the issue queue** for questions or troubleshooting. Unless you are certain that your issue is a software defect, use the [forum]. 133 134 Hugo’s [forum] is an active community of users and developers who answer questions, share knowledge, and provide examples. A quick search of over 20,000 topics will often answer your question. Please be sure to read about [requesting help] before asking your first question. 135 136 ## Contributing 137 138 You can contribute to the Hugo project by: 139 140 - Answering questions on the [forum] 141 - Improving the [documentation] 142 - Monitoring the [issue queue] 143 - Creating or improving [themes] 144 - Squashing [bugs] 145 146 Please submit documentation issues and pull requests to the [documentation repository]. 147 148 If you have an idea for an enhancement or new feature, create a new topic on the [forum] in the "Feature" category. This will help you to: 149 150 - Determine if the capability already exists 151 - Measure interest 152 - Refine the concept 153 154 If there is sufficient interest, [create a proposal]. Do not submit a pull request until the project lead accepts the proposal. 155 156 For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md). 157 158 ## Dependencies 159 160 Hugo stands on the shoulders of great open source libraries. Run `hugo env --logLevel info` to display a list of dependencies. 161 162 <details> 163 <summary>See current dependencies</summary> 164 165 ```text 166 cloud.google.com/go/compute/metadata="v0.2.3" 167 cloud.google.com/go/iam="v1.1.0" 168 cloud.google.com/go/storage="v1.30.1" 169 cloud.google.com/go="v0.110.2" 170 github.com/Azure/azure-sdk-for-go/sdk/azcore="v1.6.1" 171 github.com/Azure/azure-sdk-for-go/sdk/azidentity="v1.3.0" 172 github.com/Azure/azure-sdk-for-go/sdk/internal="v1.3.0" 173 github.com/Azure/azure-sdk-for-go/sdk/storage/azblob="v1.0.0" 174 github.com/Azure/go-autorest/autorest/to="v0.4.0" 175 github.com/AzureAD/microsoft-authentication-library-for-go="v1.0.0" 176 github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69" 177 github.com/PuerkitoBio/purell="v1.1.1" 178 github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578" 179 github.com/alecthomas/chroma/v2="v2.7.0" 180 github.com/armon/go-radix="v1.0.0" 181 github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream="v1.4.10" 182 github.com/aws/aws-sdk-go-v2/config="v1.18.27" 183 github.com/aws/aws-sdk-go-v2/credentials="v1.13.26" 184 github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.13.4" 185 github.com/aws/aws-sdk-go-v2/feature/s3/manager="v1.11.70" 186 github.com/aws/aws-sdk-go-v2/internal/configsources="v1.1.34" 187 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2="v2.4.28" 188 github.com/aws/aws-sdk-go-v2/internal/ini="v1.3.35" 189 github.com/aws/aws-sdk-go-v2/internal/v4a="v1.0.26" 190 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding="v1.9.11" 191 github.com/aws/aws-sdk-go-v2/service/internal/checksum="v1.1.29" 192 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.9.28" 193 github.com/aws/aws-sdk-go-v2/service/internal/s3shared="v1.14.3" 194 github.com/aws/aws-sdk-go-v2/service/s3="v1.35.0" 195 github.com/aws/aws-sdk-go-v2/service/sso="v1.12.12" 196 github.com/aws/aws-sdk-go-v2/service/ssooidc="v1.14.12" 197 github.com/aws/aws-sdk-go-v2/service/sts="v1.19.2" 198 github.com/aws/aws-sdk-go-v2="v1.18.1" 199 github.com/aws/aws-sdk-go="v1.44.284" 200 github.com/aws/smithy-go="v1.13.5" 201 github.com/bep/clocks="v0.5.0" 202 github.com/bep/debounce="v1.2.0" 203 github.com/bep/gitmap="v1.1.2" 204 github.com/bep/goat="v0.5.0" 205 github.com/bep/godartsass/v2="v2.0.0" 206 github.com/bep/godartsass="v1.2.0" 207 github.com/bep/golibsass="v1.1.1" 208 github.com/bep/gowebp="v0.2.0" 209 github.com/bep/lazycache="v0.2.0" 210 github.com/bep/logg="v0.2.0" 211 github.com/bep/mclib="v1.20400.20402" 212 github.com/bep/overlayfs="v0.6.0" 213 github.com/bep/simplecobra="v0.3.2" 214 github.com/bep/tmc="v0.5.1" 215 github.com/clbanning/mxj/v2="v2.5.7" 216 github.com/cli/safeexec="v1.0.1" 217 github.com/cpuguy83/go-md2man/v2="v2.0.2" 218 github.com/disintegration/gift="v1.2.1" 219 github.com/dlclark/regexp2="v1.10.0" 220 github.com/dustin/go-humanize="v1.0.1" 221 github.com/evanw/esbuild="v0.18.5" 222 github.com/fatih/color="v1.15.0" 223 github.com/frankban/quicktest="v1.14.5" 224 github.com/fsnotify/fsnotify="v1.6.0" 225 github.com/getkin/kin-openapi="v0.118.0" 226 github.com/ghodss/yaml="v1.0.0" 227 github.com/go-openapi/jsonpointer="v0.19.6" 228 github.com/go-openapi/swag="v0.22.3" 229 github.com/gobuffalo/flect="v1.0.2" 230 github.com/gobwas/glob="v0.2.3" 231 github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013" 232 github.com/gohugoio/locales="v0.14.0" 233 github.com/gohugoio/localescompressed="v1.0.1" 234 github.com/golang-jwt/jwt/v4="v4.5.0" 235 github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da" 236 github.com/golang/protobuf="v1.5.3" 237 github.com/google/go-cmp="v0.5.9" 238 github.com/google/s2a-go="v0.1.4" 239 github.com/google/uuid="v1.3.0" 240 github.com/google/wire="v0.5.0" 241 github.com/googleapis/enterprise-certificate-proxy="v0.2.5" 242 github.com/googleapis/gax-go/v2="v2.11.0" 243 github.com/gorilla/websocket="v1.5.0" 244 github.com/hairyhenderson/go-codeowners="v0.3.0" 245 github.com/hashicorp/golang-lru/v2="v2.0.1" 246 github.com/invopop/yaml="v0.1.0" 247 github.com/jdkato/prose="v1.2.1" 248 github.com/jmespath/go-jmespath="v0.4.0" 249 github.com/josharian/intern="v1.0.0" 250 github.com/kr/pretty="v0.3.1" 251 github.com/kr/text="v0.2.0" 252 github.com/kylelemons/godebug="v1.1.0" 253 github.com/kyokomi/emoji/v2="v2.2.12" 254 github.com/mailru/easyjson="v0.7.7" 255 github.com/marekm4/color-extractor="v1.2.0" 256 github.com/mattn/go-colorable="v0.1.13" 257 github.com/mattn/go-isatty="v0.0.19" 258 github.com/mattn/go-runewidth="v0.0.9" 259 github.com/mitchellh/hashstructure="v1.1.0" 260 github.com/mitchellh/mapstructure="v1.5.0" 261 github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826" 262 github.com/muesli/smartcrop="v0.3.0" 263 github.com/niklasfasching/go-org="v1.7.0" 264 github.com/olekukonko/tablewriter="v0.0.5" 265 github.com/pelletier/go-toml/v2="v2.0.8" 266 github.com/perimeterx/marshmallow="v1.1.4" 267 github.com/pkg/browser="v0.0.0-20210911075715-681adbf594b8" 268 github.com/pkg/errors="v0.9.1" 269 github.com/rogpeppe/go-internal="v1.10.1-0.20230508101108-a4f6fabd84c5" 270 github.com/russross/blackfriday/v2="v2.1.0" 271 github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd" 272 github.com/sanity-io/litter="v1.5.5" 273 github.com/sass/dart-sass/compiler="1.63.6" 274 github.com/sass/dart-sass/implementation="1.63.6" 275 github.com/sass/dart-sass/protocol="2.1.0" 276 github.com/sass/libsass="3.6.5" 277 github.com/spf13/afero="v1.9.5" 278 github.com/spf13/cast="v1.5.1" 279 github.com/spf13/cobra="v1.7.0" 280 github.com/spf13/fsync="v0.9.0" 281 github.com/spf13/pflag="v1.0.5" 282 github.com/tdewolff/minify/v2="v2.12.7" 283 github.com/tdewolff/parse/v2="v2.6.6" 284 github.com/webmproject/libwebp="v1.2.4" 285 github.com/yuin/goldmark="v1.5.4" 286 go.opencensus.io="v0.24.0" 287 go.uber.org/atomic="v1.11.0" 288 go.uber.org/automaxprocs="v1.5.2" 289 gocloud.dev="v0.30.0" 290 golang.org/x/crypto="v0.10.0" 291 golang.org/x/exp="v0.0.0-20230321023759-10a507213a29" 292 golang.org/x/image="v0.8.0" 293 golang.org/x/mod="v0.10.0" 294 golang.org/x/net="v0.11.0" 295 golang.org/x/oauth2="v0.9.0" 296 golang.org/x/sync="v0.3.0" 297 golang.org/x/sys="v0.9.0" 298 golang.org/x/text="v0.10.0" 299 golang.org/x/tools="v0.9.3" 300 golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2" 301 google.golang.org/api="v0.128.0" 302 google.golang.org/appengine="v1.6.7" 303 google.golang.org/genproto/googleapis/api="v0.0.0-20230530153820-e85fd2cbaebc" 304 google.golang.org/genproto/googleapis/rpc="v0.0.0-20230530153820-e85fd2cbaebc" 305 google.golang.org/genproto="v0.0.0-20230530153820-e85fd2cbaebc" 306 google.golang.org/grpc="v1.56.0" 307 google.golang.org/protobuf="v1.30.0" 308 gopkg.in/yaml.v2="v2.4.0" 309 gopkg.in/yaml.v3="v3.0.1" 310 software.sslmate.com/src/go-pkcs12="v0.2.0" 311 ``` 312 </details>