rules_hugo
所属分类:collect
开发工具:Starlark
文件大小:0KB
下载次数:0
上传日期:2023-07-09 08:18:50
上 传 者:
sh-1993
说明: 雨果静态网站生成器的Bazel构建规则,
(Bazel build rules for hugo static website generator,)
文件列表:
.bazeliskrc (72, 2022-11-22)
.bazelversion (6, 2022-11-22)
.cirrus.yml (282, 2022-11-22)
LICENSE (553, 2022-11-22)
WORKSPACE (941, 2022-11-22)
hugo/ (0, 2022-11-22)
hugo/BUILD (578, 2022-11-22)
hugo/internal/ (0, 2022-11-22)
hugo/internal/github_hugo_theme.bzl (1030, 2022-11-22)
hugo/internal/hugo_repository.bzl (1472, 2022-11-22)
hugo/internal/hugo_site.bzl (9395, 2022-11-22)
hugo/internal/hugo_theme.bzl (466, 2022-11-22)
hugo/rules.bzl (481, 2022-11-22)
site_complex/ (0, 2022-11-22)
site_complex/BUILD (1137, 2022-11-22)
site_complex/config/ (0, 2022-11-22)
site_complex/config/_default/ (0, 2022-11-22)
site_complex/config/_default/config.yaml (1144, 2022-11-22)
site_complex/config/_default/languages.yaml (651, 2022-11-22)
site_complex/config/_default/params.yaml (1113, 2022-11-22)
site_complex/content/ (0, 2022-11-22)
site_complex/content/en/ (0, 2022-11-22)
site_complex/content/en/_index.md (140, 2022-11-22)
site_complex/content/en/contributing/ (0, 2022-11-22)
site_complex/content/en/contributing/_index.md (55, 2022-11-22)
site_complex/content/en/contributing/code_of_conduct.md (44, 2022-11-22)
site_complex/data/ (0, 2022-11-22)
site_complex/data/menu/ (0, 2022-11-22)
site_complex/data/menu/main.yaml (743, 2022-11-22)
site_simple/ (0, 2022-11-22)
site_simple/BUILD.bazel (551, 2022-11-22)
site_simple/assets/ (0, 2022-11-22)
site_simple/assets/_custom.scss (21, 2022-11-22)
site_simple/config.yaml (1733, 2022-11-22)
site_simple/content/ (0, 2022-11-22)
site_simple/content/_index.md (2373, 2022-11-22)
site_simple/content/docs/ (0, 2022-11-22)
site_simple/content/docs/about.md (2431, 2022-11-22)
... ...
# `rules_hugo`
[![Build Status](https://api.cirrus-ci.com/github/stackb/rules_hugo.svg)](https://cirrus-ci.com/github/stackb/rules_hugo)
|
|
Rules |
Hugo |
[Bazel](https://bazel.build) rules for building static websites with [Hugo](https://gohugo.io).
## Repository Rules
| Name | Description |
| -------------------: | :----------- |
| [hugo_repository](#hugo_repository) | Load hugo dependency for this repo. |
| [github_hugo_theme](#github_hugo_theme) | Load a hugo theme from github. |
## Build Rules
| Name | Description |
| -------------------: | :----------- |
| [hugo_site](#hugo_site) | Declare a hugo site. |
| [hugo_theme](#hugo_theme) | Declare a hugo theme. |
## Usage
### Add rules_hugo to your WORKSPACE and add a theme from github
```python
# Update these to latest
RULES_HUGO_COMMIT = "..."
RULES_HUGO_SHA256 = "..."
http_archive(
name = "build_stack_rules_hugo",
url = "https://github.com/stackb/rules_hugo/archive/%s.zip" % RULES_HUGO_COMMIT,
sha256 = RULES_HUGO_SHA256,
strip_prefix = "rules_hugo-%s" % RULES_HUGO_COMMIT
)
load("@build_stack_rules_hugo//hugo:rules.bzl", "hugo_repository", "github_hugo_theme")
#
# Load hugo binary itself
#
# Optionally, load a specific version of Hugo, with the 'version' argument
hugo_repository(
name = "hugo",
)
#
# This makes a filegroup target "@com_github_yihui_hugo_xmin//:files"
# available to your build files
#
github_hugo_theme(
name = "com_github_yihui_hugo_xmin",
owner = "yihui",
repo = "hugo-xmin",
commit = "c14ca049d0dd60386264ea68c91d8495809cc4c6",
)
#
# This creates a filegroup target from a released archive from GitHub
# this is useful when a theme uses compiled / aggregated sources NOT found
# in a source root.
#
http_archive(
name = "com_github_thegeeklab_hugo_geekdoc",
url = "https://github.com/thegeeklab/hugo-geekdoc/releases/download/v0.34.2/hugo-geekdoc.tar.gz",
sha256 = "7fdd57f7d4450325a778629021c0fff5531dc8475de6c4ec70ab07e9484d400e",
build_file_content="""
filegroup(
name = "files",
srcs = glob(["**"]),
visibility = ["//visibility:public"]
)
"""
)
```
### Declare a hugo_site with a GitHub repository theme in your BUILD file
```python
load("@build_stack_rules_hugo//hugo:rules.bzl", "hugo_site", "hugo_theme", "hugo_serve")
# Declare a theme 'xmin'. In this case the `name` and
# `theme_name` are identical, so the `theme_name` could be omitted in this case.
hugo_theme(
name = "xmin",
theme_name = "xmin",
srcs = [
"@com_github_yihui_hugo_xmin//:files",
],
)
# Declare a site. Config file is required.
my_site_name = "basic"
hugo_site(
name = my_site_name,
config = "config.toml",
content = [
"_index.md",
"about.md",
],
quiet = False,
theme = ":xmin",
)
# Run local development server
hugo_serve(
name = "local_%s" % my_site_name,
dep = [":%s" % my_site_name],
)
# Tar it up
pkg_tar(
name = "%s_tar" % my_site_name,
srcs = [":%s" % my_site_name],
)
```
### Declare a hugo_site with a GitHub released archive theme in your BUILD file
```python
load("@build_stack_rules_hugo//hugo:rules.bzl", "hugo_site", "hugo_theme", "hugo_serve")
hugo_theme(
name = "hugo_theme_geekdoc",
theme_name = "hugo-geekdoc",
srcs = [
"@com_github_thegeeklab_hugo_geekdoc//:files",
],
)
# Note, here we are using the config_dir attribute to support multi-lingual configurations.
hugo_site(
name = "site_complex",
config_dir = glob(["config/**"]),
content = glob(["content/**"]),
data = glob(["data/**"]),
quiet = False,
theme = ":hugo_theme_geekdoc",
)
# Run local development server
hugo_serve(
name = "serve",
dep = [":site_complex"],
)
```
### Previewing the site
Execute the following command:
```shell
bazel run //site_complex:serve
```
Then open your browser: [here](http://localhost:1313)
### Build the site
The `hugo_site` target emits the output in the `bazel-bin` directory.
```sh
$ bazel build :basic
[...]
Target //:basic up-to-date:
bazel-bin/basic
[...]
```
```sh
$ tree bazel-bin/basic
bazel-bin/basic
├── 404.html
├── about
│ └── index.html
[...]
```
The `pkg_tar` target emits a `%{name}_tar.tar` file containing all the Hugo output files.
```sh
$ bazel build :basic_tar
[...]
Target //:basic up-to-date:
bazel-bin/basic_tar.tar
```
## End
See source code for details about additional rule attributes / parameters.
近期下载者:
相关文件:
收藏者: