Skip to content

Commit deeca5f

Browse files
Fix code review issues: restore README and improve CSS consistency
Co-authored-by: CarlosNihelton <11138291+CarlosNihelton@users.noreply.github.com>
1 parent 84b43b6 commit deeca5f

File tree

5 files changed

+170
-265
lines changed

5 files changed

+170
-265
lines changed

README.md

Lines changed: 57 additions & 260 deletions
Original file line numberDiff line numberDiff line change
@@ -1,293 +1,90 @@
1-
[bep]: https://github.com/bep
2-
[bugs]: https://github.com/gohugoio/hugo/issues?q=is%3Aopen+is%3Aissue+label%3ABug
3-
[contributing]: CONTRIBUTING.md
4-
[create a proposal]: https://github.com/gohugoio/hugo/issues/new?labels=Proposal%2C+NeedsTriage&template=feature_request.md
5-
[documentation repository]: https://github.com/gohugoio/hugoDocs
6-
[documentation]: https://gohugo.io/documentation
7-
[dragonfly bsd, freebsd, netbsd, and openbsd]: https://gohugo.io/installation/bsd
8-
[forum]: https://discourse.gohugo.io
9-
[friends]: https://github.com/gohugoio/hugo/graphs/contributors
10-
[go]: https://go.dev/
11-
[hugo modules]: https://gohugo.io/hugo-modules/
12-
[installation]: https://gohugo.io/installation
13-
[issue queue]: https://github.com/gohugoio/hugo/issues
14-
[linux]: https://gohugo.io/installation/linux
15-
[macos]: https://gohugo.io/installation/macos
16-
[prebuilt binary]: https://github.com/gohugoio/hugo/releases/latest
17-
[requesting help]: https://discourse.gohugo.io/t/requesting-help/9132
18-
[spf13]: https://github.com/spf13
19-
[static site generator]: https://en.wikipedia.org/wiki/Static_site_generator
20-
[support]: https://discourse.gohugo.io
21-
[themes]: https://themes.gohugo.io/
22-
[twitter]: https://twitter.com/gohugoio
23-
[website]: https://gohugo.io
24-
[windows]: https://gohugo.io/installation/windows
1+
# A hugo theme to build **m**odern **A**scii**D**oc-based **b**logs.
252

26-
<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>
3+
![mADb](./images/madb.webp)
274

28-
A fast and flexible static site generator built with love by [bep], [spf13], and [friends] in [Go].
5+
A humble for of "https://github.com/basil/antora-default-ui-hugo-theme/" that drifts from its main purpose to
6+
build a more blogging-like simple and modern platform.
297

30-
---
8+
[![MPL 2.0 License](https://img.shields.io/badge/License-MPL%202.0-blue.svg)](https://github.com/basil/antora-default-ui-hugo-theme/blob/master/LICENSE)
319

32-
[![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://godoc.org/github.com/gohugoio/hugo)
33-
[![Tests on Linux, MacOS and Windows](https://github.com/gohugoio/hugo/workflows/Test/badge.svg)](https://github.com/gohugoio/hugo/actions?query=workflow%3ATest)
34-
[![Go Report Card](https://goreportcard.com/badge/github.com/gohugoio/hugo)](https://goreportcard.com/report/github.com/gohugoio/hugo)
10+
Antora Default UI Theme for Hugo is a Hugo theme based on the [Antora default UI](https://gitlab.com/antora/antora-ui-default), with full support for [Asciidoctor](https://asciidoctor.org/). **([_Demo_](https://antora-default-ui-hugo-theme.netlify.app/))**
3511

36-
[Website] | [Installation] | [Documentation] | [Support] | [Contributing] | <a rel="me" href="https://fosstodon.org/@gohugoio">Mastodon</a>
12+
## Screenshot
3713

38-
## Overview
14+
TODO
3915

40-
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.
16+
## Prerequisites
4117

42-
Due to its flexible framework, multilingual support, and powerful taxonomy system, Hugo is widely used to create:
18+
Before starting, ensure that you have [installed Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and [created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site).
4319

44-
- Corporate, government, nonprofit, education, news, event, and project sites
45-
- Documentation sites
46-
- Image portfolios
47-
- Landing pages
48-
- Business, professional, and personal blogs
49-
- Resumes and CVs
50-
51-
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.
52-
53-
Hugo's fast asset pipelines include:
54-
55-
- CSS bundling &ndash; transpilation (Sass), tree shaking, minification, source maps, SRI hashing, and PostCSS integration
56-
- JavaScript bundling &ndash; transpilation (TypeScript, JSX), tree shaking, minification, source maps, and SRI hashing
57-
- Image processing &ndash; convert, resize, crop, rotate, adjust colors, apply filters, overlay text and images, and extract EXIF data
58-
59-
And with [Hugo Modules], you can share content, assets, data, translations, themes, templates, and configuration with other projects via public or private Git repositories.
60-
61-
## Sponsors
62-
63-
<p>&nbsp;</p>
64-
<p float="left">
65-
<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>
66-
&nbsp;&nbsp;&nbsp;
67-
<a href="https://route4me.com/" target="_blank"><img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/assets/images/sponsors/Route4MeLogoBlueOnWhite.svg" width="200" alt="Route Planning & Route Optimization Software"></a>
68-
</p>
20+
Also ensure that you have [installed Asciidoctor](https://asciidoctor.org/docs/install-toolchain/).
6921

7022
## Installation
7123

72-
Install Hugo from a [prebuilt binary], package manager, or package repository. Please see the installation instructions for your operating system:
73-
74-
- [macOS]
75-
- [Linux]
76-
- [Windows]
77-
- [DragonFly BSD, FreeBSD, NetBSD, and OpenBSD]
78-
79-
## Build from source
80-
81-
Hugo is available in two editions: standard and extended. With the extended edition you can:
82-
83-
- Encode to the WebP format when processing images. You can decode WebP images with either edition.
84-
- Transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.
24+
TODO: Demo with the modern hugo module workflow.
8525

86-
Prerequisites to build Hugo from source:
26+
## Configuration
8727

88-
- Standard edition: Go 1.20 or later
89-
- Extended edition: Go 1.20 or later, and GCC
28+
Configure the Asciidoctor attributes in your site's configuration file (`config.toml`) for use with this theme:
9029

91-
Build the standard edition:
92-
93-
```text
94-
go install github.com/gohugoio/hugo@latest
30+
```toml
31+
[markup]
32+
[markup.asciidocext]
33+
[markup.asciidocext.attributes]
34+
"icons" = "font"
35+
"source-highlighter" = "rouge"
36+
[markup.highlight]
37+
codeFences = true
9538
```
9639

97-
Build the extended edition:
40+
Optionally, configure a description and keywords for the home page:
9841

99-
```text
100-
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
42+
```toml
43+
[params]
44+
description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
45+
keywords = ["foo", "bar"]
10146
```
10247

103-
## Documentation
104-
105-
Hugo's [documentation] includes installation instructions, a quick start guide, conceptual explanations, reference information, and examples.
106-
107-
Please submit documentation issues and pull requests to the [documentation repository].
108-
109-
## Support
110-
111-
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].
48+
Optionally, configure a copyright message and year for the footer:
11249

113-
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.
50+
```toml
51+
copyright = "<name>. All rights reserved."
11452

115-
## Contributing
53+
[params]
54+
since = <year>
55+
```
11656

117-
You can contribute to the Hugo project by:
57+
Optionally, configure a URL for use with the **Edit this page** feature:
11858

119-
- Answering questions on the [forum]
120-
- Improving the [documentation]
121-
- Monitoring the [issue queue]
122-
- Creating or improving [themes]
123-
- Squashing [bugs]
59+
```toml
60+
[params]
61+
editThisPage = "https://github.com/organization/repository/edit/main/content/"
62+
```
12463

125-
Please submit documentation issues and pull requests to the [documentation repository].
64+
### Customization
12665

127-
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:
66+
One or more custom CSS files can be added to the site output by informing their paths relative to the
67+
`assets/` directory via the site configuration, for example:
12868

129-
- Determine if the capability already exists
130-
- Measure interest
131-
- Refine the concept
69+
```toml
70+
[params]
71+
custom_css = ["carrousel.css", "profile.css"]
72+
```
13273

133-
If there is sufficient interest, [create a proposal]. Do not submit a pull request until the project lead accepts the proposal.
74+
### Syntax Highlighting
13475

135-
For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md).
76+
TODO: Document better how to work with rouge.
77+
This theme uses [Rouge](https://rouge.jneen.net/) or [highlight.js](https://highlightjs.org/) for syntax
78+
highlighting. The version of highlight.js shipped in this theme supports all of the highlight.js common
79+
languages and AsciiDoc. To add support for additional languages, [download a custom
80+
package](https://highlightjs.org/download/) with the desired languages and place it in
81+
`assets/js/vendor/highlight.pack.js`.
13682

137-
## Dependencies
83+
## License
13884

139-
Hugo stands on the shoulders of great open source libraries. Run `hugo env --logLevel info` to display a list of dependencies.
85+
Released under the [Mozilla Public License, Version 2.0](https://github.com/olivecdev/hugo-madb/blob/main/LICENSE) (MPL-2.0).
14086

141-
<details>
142-
<summary>See current dependencies</summary>
87+
## Acknowledgements
14388

144-
```text
145-
cloud.google.com/go/compute/metadata="v0.2.3"
146-
cloud.google.com/go/iam="v1.1.3"
147-
cloud.google.com/go/storage="v1.31.0"
148-
cloud.google.com/go="v0.110.8"
149-
github.com/Azure/azure-sdk-for-go/sdk/azcore="v1.7.0"
150-
github.com/Azure/azure-sdk-for-go/sdk/azidentity="v1.3.0"
151-
github.com/Azure/azure-sdk-for-go/sdk/internal="v1.3.0"
152-
github.com/Azure/azure-sdk-for-go/sdk/storage/azblob="v1.1.0"
153-
github.com/Azure/go-autorest/autorest/to="v0.4.0"
154-
github.com/AzureAD/microsoft-authentication-library-for-go="v1.0.0"
155-
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
156-
github.com/PuerkitoBio/purell="v1.1.1"
157-
github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
158-
github.com/alecthomas/chroma/v2="v2.11.1"
159-
github.com/armon/go-radix="v1.0.0"
160-
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream="v1.4.11"
161-
github.com/aws/aws-sdk-go-v2/config="v1.18.32"
162-
github.com/aws/aws-sdk-go-v2/credentials="v1.13.31"
163-
github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.13.7"
164-
github.com/aws/aws-sdk-go-v2/feature/s3/manager="v1.11.76"
165-
github.com/aws/aws-sdk-go-v2/internal/configsources="v1.1.37"
166-
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2="v2.4.31"
167-
github.com/aws/aws-sdk-go-v2/internal/ini="v1.3.38"
168-
github.com/aws/aws-sdk-go-v2/internal/v4a="v1.1.0"
169-
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding="v1.9.12"
170-
github.com/aws/aws-sdk-go-v2/service/internal/checksum="v1.1.32"
171-
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.9.31"
172-
github.com/aws/aws-sdk-go-v2/service/internal/s3shared="v1.15.0"
173-
github.com/aws/aws-sdk-go-v2/service/s3="v1.38.1"
174-
github.com/aws/aws-sdk-go-v2/service/sso="v1.13.1"
175-
github.com/aws/aws-sdk-go-v2/service/ssooidc="v1.15.1"
176-
github.com/aws/aws-sdk-go-v2/service/sts="v1.21.1"
177-
github.com/aws/aws-sdk-go-v2="v1.20.0"
178-
github.com/aws/aws-sdk-go="v1.48.2"
179-
github.com/aws/smithy-go="v1.14.0"
180-
github.com/bep/clocks="v0.5.0"
181-
github.com/bep/debounce="v1.2.0"
182-
github.com/bep/gitmap="v1.1.2"
183-
github.com/bep/goat="v0.5.0"
184-
github.com/bep/godartsass/v2="v2.0.0"
185-
github.com/bep/godartsass="v1.2.0"
186-
github.com/bep/golibsass="v1.1.1"
187-
github.com/bep/gowebp="v0.3.0"
188-
github.com/bep/lazycache="v0.2.0"
189-
github.com/bep/logg="v0.3.0"
190-
github.com/bep/mclib="v1.20400.20402"
191-
github.com/bep/overlayfs="v0.6.0"
192-
github.com/bep/simplecobra="v0.3.2"
193-
github.com/bep/tmc="v0.5.1"
194-
github.com/clbanning/mxj/v2="v2.7.0"
195-
github.com/cli/safeexec="v1.0.1"
196-
github.com/cpuguy83/go-md2man/v2="v2.0.2"
197-
github.com/disintegration/gift="v1.2.1"
198-
github.com/dlclark/regexp2="v1.10.0"
199-
github.com/dustin/go-humanize="v1.0.1"
200-
github.com/evanw/esbuild="v0.19.7"
201-
github.com/fatih/color="v1.16.0"
202-
github.com/frankban/quicktest="v1.14.6"
203-
github.com/fsnotify/fsnotify="v1.7.0"
204-
github.com/getkin/kin-openapi="v0.120.0"
205-
github.com/ghodss/yaml="v1.0.0"
206-
github.com/go-openapi/jsonpointer="v0.19.6"
207-
github.com/go-openapi/swag="v0.22.4"
208-
github.com/gobuffalo/flect="v1.0.2"
209-
github.com/gobwas/glob="v0.2.3"
210-
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20230805085216-e63c13218d0e"
211-
github.com/gohugoio/locales="v0.14.0"
212-
github.com/gohugoio/localescompressed="v1.0.1"
213-
github.com/golang-jwt/jwt/v4="v4.5.0"
214-
github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
215-
github.com/golang/protobuf="v1.5.3"
216-
github.com/google/go-cmp="v0.6.0"
217-
github.com/google/s2a-go="v0.1.7"
218-
github.com/google/uuid="v1.4.0"
219-
github.com/google/wire="v0.5.0"
220-
github.com/googleapis/enterprise-certificate-proxy="v0.3.2"
221-
github.com/googleapis/gax-go/v2="v2.12.0"
222-
github.com/gorilla/websocket="v1.5.1"
223-
github.com/hairyhenderson/go-codeowners="v0.4.0"
224-
github.com/hashicorp/golang-lru/v2="v2.0.1"
225-
github.com/invopop/yaml="v0.2.0"
226-
github.com/jdkato/prose="v1.2.1"
227-
github.com/jmespath/go-jmespath="v0.4.0"
228-
github.com/josharian/intern="v1.0.0"
229-
github.com/kr/pretty="v0.3.1"
230-
github.com/kr/text="v0.2.0"
231-
github.com/kylelemons/godebug="v1.1.0"
232-
github.com/kyokomi/emoji/v2="v2.2.12"
233-
github.com/mailru/easyjson="v0.7.7"
234-
github.com/marekm4/color-extractor="v1.2.1"
235-
github.com/mattn/go-colorable="v0.1.13"
236-
github.com/mattn/go-isatty="v0.0.20"
237-
github.com/mattn/go-runewidth="v0.0.9"
238-
github.com/mitchellh/hashstructure="v1.1.0"
239-
github.com/mitchellh/mapstructure="v1.5.0"
240-
github.com/mohae/deepcopy="v0.0.0-20170929034955-c48cc78d4826"
241-
github.com/muesli/smartcrop="v0.3.0"
242-
github.com/niklasfasching/go-org="v1.7.0"
243-
github.com/olekukonko/tablewriter="v0.0.5"
244-
github.com/pelletier/go-toml/v2="v2.1.0"
245-
github.com/perimeterx/marshmallow="v1.1.5"
246-
github.com/pkg/browser="v0.0.0-20210911075715-681adbf594b8"
247-
github.com/pkg/errors="v0.9.1"
248-
github.com/rogpeppe/go-internal="v1.11.0"
249-
github.com/russross/blackfriday/v2="v2.1.0"
250-
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
251-
github.com/sanity-io/litter="v1.5.5"
252-
github.com/sass/dart-sass/compiler="1.63.2"
253-
github.com/sass/dart-sass/implementation="1.63.2"
254-
github.com/sass/dart-sass/protocol="2.0.0"
255-
github.com/sass/libsass="3.6.5"
256-
github.com/spf13/afero="v1.10.0"
257-
github.com/spf13/cast="v1.5.1"
258-
github.com/spf13/cobra="v1.7.0"
259-
github.com/spf13/fsync="v0.9.0"
260-
github.com/spf13/pflag="v1.0.5"
261-
github.com/tdewolff/minify/v2="v2.20.7"
262-
github.com/tdewolff/parse/v2="v2.7.5"
263-
github.com/webmproject/libwebp="v1.3.2"
264-
github.com/yuin/goldmark-emoji="v1.0.2"
265-
github.com/yuin/goldmark="v1.6.0"
266-
go.opencensus.io="v0.24.0"
267-
go.uber.org/atomic="v1.11.0"
268-
go.uber.org/automaxprocs="v1.5.3"
269-
gocloud.dev="v0.34.0"
270-
golang.org/x/crypto="v0.15.0"
271-
golang.org/x/exp="v0.0.0-20221031165847-c99f073a8326"
272-
golang.org/x/image="v0.13.0"
273-
golang.org/x/mod="v0.14.0"
274-
golang.org/x/net="v0.18.0"
275-
golang.org/x/oauth2="v0.13.0"
276-
golang.org/x/sync="v0.5.0"
277-
golang.org/x/sys="v0.14.0"
278-
golang.org/x/text="v0.14.0"
279-
golang.org/x/time="v0.3.0"
280-
golang.org/x/tools="v0.15.0"
281-
golang.org/x/xerrors="v0.0.0-20220907171357-04be3eba64a2"
282-
google.golang.org/api="v0.151.0"
283-
google.golang.org/genproto/googleapis/api="v0.0.0-20231016165738-49dd2c1f3d0b"
284-
google.golang.org/genproto/googleapis/rpc="v0.0.0-20231030173426-d783a09b4405"
285-
google.golang.org/genproto="v0.0.0-20231016165738-49dd2c1f3d0b"
286-
google.golang.org/grpc="v1.59.0"
287-
google.golang.org/protobuf="v1.31.0"
288-
gopkg.in/yaml.v2="v2.4.0"
289-
gopkg.in/yaml.v3="v3.0.1"
290-
howett.net/plist="v1.0.0"
291-
software.sslmate.com/src/go-pkcs12="v0.2.0"
292-
```
293-
</details>
89+
- [Dan Allen](https://github.com/mojavelinux), [Asciidoctor](https://asciidoctor.org/) Project Lead & [Antora](https://antora.org/) Project Co-Lead
90+
- [Basil Crow](https://github.com/basil), [Antora Default UI Theme for Hugo](https://github.com/basil/antora-default-ui-hugo-theme) Project author, lead and owner.

0 commit comments

Comments
 (0)