Compare commits
402 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
67f1708691 | ||
![]() |
c5e5ec0f21 | ||
![]() |
d461333738 | ||
![]() |
32c422a2a8 | ||
![]() |
b66660b557 | ||
![]() |
be95c3cd68 | ||
![]() |
74aa32e595 | ||
![]() |
4c305b38a5 | ||
![]() |
63c609c1d3 | ||
![]() |
d7424d26eb | ||
![]() |
1f66740c19 | ||
![]() |
cb032b4fb8 | ||
![]() |
3889382e19 | ||
![]() |
86addfd6dd | ||
![]() |
9110fb5ab4 | ||
![]() |
fad4cdbfd2 | ||
![]() |
c403d422d9 | ||
![]() |
0ecfa72864 | ||
![]() |
62af498414 | ||
![]() |
ee37599ded | ||
![]() |
9a4c7c7776 | ||
![]() |
c05eeb015c | ||
![]() |
d9f898a2e1 | ||
![]() |
36f31a57ae | ||
![]() |
17b3bbaf80 | ||
![]() |
26bc4ebb00 | ||
![]() |
d13d80af2f | ||
![]() |
64abaf8d1e | ||
![]() |
ffc9c47b45 | ||
![]() |
092630b030 | ||
![]() |
2ec60a8b71 | ||
![]() |
9af871fee7 | ||
![]() |
883ab3f7a0 | ||
![]() |
d6a49ccb90 | ||
![]() |
fdc58d52e9 | ||
![]() |
97a829dfff | ||
![]() |
c7fbc548bb | ||
![]() |
794510861c | ||
![]() |
da7c70c444 | ||
![]() |
1571decb8e | ||
![]() |
835d3e615e | ||
![]() |
393aea46e1 | ||
![]() |
f3347e871e | ||
![]() |
9d751abbf0 | ||
![]() |
ccfc674019 | ||
![]() |
45aa488e37 | ||
![]() |
5d96fdb3db | ||
![]() |
c2faf0d4f6 | ||
![]() |
1e8d94e1fb | ||
![]() |
3a6edbf2a2 | ||
![]() |
a52154b531 | ||
![]() |
a27d25737f | ||
![]() |
e810df9177 | ||
![]() |
d4dc5d8693 | ||
![]() |
878258796b | ||
![]() |
0397b66d05 | ||
![]() |
5ef32bed6d | ||
![]() |
bbdd8b6c62 | ||
![]() |
67a1d58178 | ||
![]() |
1bede70fae | ||
![]() |
156dbfd3a9 | ||
![]() |
c2a2ffd06d | ||
![]() |
6aeb1ae617 | ||
![]() |
9fe02aa39b | ||
![]() |
f6f65ef7f3 | ||
![]() |
8b8a6b5b36 | ||
![]() |
9fabcbaf13 | ||
![]() |
18ad1ebc93 | ||
![]() |
f4cde441a0 | ||
![]() |
1baea7f63d | ||
![]() |
89b7aa24e9 | ||
![]() |
2ebbf5a370 | ||
![]() |
595e562814 | ||
![]() |
2bf64805dc | ||
![]() |
0576f78240 | ||
![]() |
0f06571e50 | ||
![]() |
bb834c9c15 | ||
![]() |
f000d95533 | ||
![]() |
d3738657a3 | ||
![]() |
d2655290b4 | ||
![]() |
97fd864129 | ||
![]() |
44d2f3699f | ||
![]() |
7bc7621996 | ||
![]() |
19b6a7817d | ||
![]() |
eddfe93e6e | ||
![]() |
a5b3b61e23 | ||
![]() |
6586370d75 | ||
![]() |
c1de0a4604 | ||
![]() |
e71908e2a8 | ||
![]() |
053b63a580 | ||
![]() |
276b2e7ab5 | ||
![]() |
db5cadb2ac | ||
![]() |
a6669030d8 | ||
![]() |
8cbd2db6fa | ||
![]() |
b09b411b10 | ||
![]() |
b4414c9ecb | ||
![]() |
e6a4d9a643 | ||
![]() |
4c4bce6e1e | ||
![]() |
5c6c934499 | ||
![]() |
f163c870cd | ||
![]() |
b6035d2aa8 | ||
![]() |
2eed95a45d | ||
![]() |
9019ea8d3c | ||
![]() |
bd88950647 | ||
![]() |
7b2d88d9d7 | ||
![]() |
c6cc6e03eb | ||
![]() |
afc023d580 | ||
![]() |
d3a15b5b1e | ||
![]() |
d928f6d4fd | ||
![]() |
f2559c243f | ||
![]() |
0e073465ae | ||
![]() |
f5dafb50a8 | ||
![]() |
671cd1f0f2 | ||
![]() |
e15052db22 | ||
![]() |
6be2bb28f8 | ||
![]() |
31e4161258 | ||
![]() |
44d018fa7c | ||
![]() |
3a49d0ca73 | ||
![]() |
c5ac3bbd3c | ||
![]() |
6fe0df9466 | ||
![]() |
2fc134503c | ||
![]() |
f11e98367b | ||
![]() |
0ad4875ee2 | ||
![]() |
a227a01407 | ||
![]() |
a8c8546c23 | ||
![]() |
0aa2a0427b | ||
![]() |
3047f8e937 | ||
![]() |
d144bd328c | ||
![]() |
8815642bea | ||
![]() |
cb862374fd | ||
![]() |
60265ce7e8 | ||
![]() |
eec1c0954a | ||
![]() |
8aa0556298 | ||
![]() |
c92c1686cd | ||
![]() |
f2509b07af | ||
![]() |
4b606deafd | ||
![]() |
d9f805d4a4 | ||
![]() |
a62bea018b | ||
![]() |
2596f2d7ee | ||
![]() |
2bcd955402 | ||
![]() |
511ad2cb4c | ||
![]() |
b87a91f6df | ||
![]() |
11b8bb4c69 | ||
![]() |
84fab6b8a8 | ||
![]() |
656770352a | ||
![]() |
1dadce3f92 | ||
![]() |
8d428d3b51 | ||
![]() |
8de8204f0e | ||
![]() |
e5d2ece0b7 | ||
![]() |
01159ceea2 | ||
![]() |
d6357b70ae | ||
![]() |
eb000e9f81 | ||
![]() |
efe9c2e06e | ||
![]() |
4c41cbcafb | ||
![]() |
1910af163d | ||
![]() |
cba1566ba1 | ||
![]() |
69abe3ec0c | ||
![]() |
9961d8e364 | ||
![]() |
7b1f81cd9a | ||
![]() |
1dd91da4f5 | ||
![]() |
624d89118d | ||
![]() |
ddab72c463 | ||
![]() |
c95ccd22eb | ||
![]() |
ced7196084 | ||
![]() |
9c726191de | ||
![]() |
93a6fab67f | ||
![]() |
923ff12915 | ||
![]() |
aaa299ef1d | ||
![]() |
e93bfcce8e | ||
![]() |
d3847186b7 | ||
![]() |
ac956333d4 | ||
![]() |
08ab28bfea | ||
![]() |
18d4548b8d | ||
![]() |
38f4fe796b | ||
![]() |
04e4c37f3e | ||
![]() |
c4695dd771 | ||
![]() |
cb75b6c777 | ||
![]() |
827fcd9d4d | ||
![]() |
21f1678de4 | ||
![]() |
f0cfd49983 | ||
![]() |
61fb294dfd | ||
![]() |
7e1843febe | ||
![]() |
7ed4693f40 | ||
![]() |
6c08d5eda1 | ||
![]() |
79e1b0aae1 | ||
![]() |
f3225ff139 | ||
![]() |
f0389f83b7 | ||
![]() |
d8271aa83a | ||
![]() |
c523f2b890 | ||
![]() |
6a32015d08 | ||
![]() |
e576737ff1 | ||
![]() |
08fa4d8c89 | ||
![]() |
7086700562 | ||
![]() |
a8fbdad172 | ||
![]() |
d374f50b66 | ||
![]() |
f0210348c6 | ||
![]() |
d66b093281 | ||
![]() |
bda9550c16 | ||
![]() |
36a4d93321 | ||
![]() |
26aeec106a | ||
![]() |
d419bb8f67 | ||
![]() |
b840ce6cf4 | ||
![]() |
816b7ca920 | ||
![]() |
3534141678 | ||
![]() |
7125033baa | ||
![]() |
042fa303be | ||
![]() |
5bd83f8255 | ||
![]() |
f0d18dc909 | ||
![]() |
128f9d6071 | ||
![]() |
f0be69daf5 | ||
![]() |
d21bc1fe42 | ||
![]() |
6da61c23db | ||
![]() |
454efc5915 | ||
![]() |
aa139ec51a | ||
![]() |
a7844486bf | ||
![]() |
221dc23a05 | ||
![]() |
92d97f7091 | ||
![]() |
51b31cb98a | ||
![]() |
2935b60404 | ||
![]() |
fc74085a7f | ||
![]() |
cd6b7332ab | ||
![]() |
ef952f73f8 | ||
![]() |
4a3a6d5395 | ||
![]() |
b4186265ef | ||
![]() |
ac5ae9aeb8 | ||
![]() |
d15eced48c | ||
![]() |
7a66470b67 | ||
![]() |
1b772f8a18 | ||
![]() |
29c49350a2 | ||
![]() |
6f0e767610 | ||
![]() |
013937d60f | ||
![]() |
dc99a35258 | ||
![]() |
3b4c4cb02f | ||
![]() |
56929c918a | ||
![]() |
696ccbf64b | ||
![]() |
2e5028a612 | ||
![]() |
89ecf07f23 | ||
![]() |
ea9295da62 | ||
![]() |
b6b5230cc3 | ||
![]() |
b65110fdcc | ||
![]() |
6d3dc7b590 | ||
![]() |
7bb479194b | ||
![]() |
73c1cf8a59 | ||
![]() |
20ce3580c7 | ||
![]() |
2f733a709d | ||
![]() |
96b1eaaa04 | ||
![]() |
f0200f77dc | ||
![]() |
4ab462750c | ||
![]() |
597ea2fa2b | ||
![]() |
82b8228277 | ||
![]() |
6a025f80c4 | ||
![]() |
99d4d79537 | ||
![]() |
e1d1526b10 | ||
![]() |
8808c10402 | ||
![]() |
87f1733a49 | ||
![]() |
0da862db93 | ||
![]() |
2bdcce58a7 | ||
![]() |
e81456021e | ||
![]() |
2815cda0ed | ||
![]() |
bad3a6fd4b | ||
![]() |
53a779ca78 | ||
![]() |
f559ae17fd | ||
![]() |
3bf1cd9ef7 | ||
![]() |
1596b40689 | ||
![]() |
1506281000 | ||
![]() |
a0a550d070 | ||
![]() |
0fe6e477a4 | ||
![]() |
a8618e1da3 | ||
![]() |
e724130159 | ||
![]() |
831fc66534 | ||
![]() |
ba8631b6a3 | ||
![]() |
0092588d87 | ||
![]() |
210f02089f | ||
![]() |
6508caec70 | ||
![]() |
5123cd1d6b | ||
![]() |
ed0b3c9da3 | ||
![]() |
55100c9b62 | ||
![]() |
1728c66dcc | ||
![]() |
4fa17934fd | ||
![]() |
263adc92e2 | ||
![]() |
0b4f63f300 | ||
![]() |
6cdd79ac3c | ||
![]() |
6c590a83a8 | ||
![]() |
3e98e3ff81 | ||
![]() |
18dd8ae837 | ||
![]() |
9e9bd2fb60 | ||
![]() |
f50b2ff166 | ||
![]() |
f3bfa8f823 | ||
![]() |
4764c02fe3 | ||
![]() |
ef20fb7a22 | ||
![]() |
d74d9b5bee | ||
![]() |
2bff77cdae | ||
![]() |
6c319a4ab8 | ||
![]() |
2f0e9f8a03 | ||
![]() |
99e9d4902b | ||
![]() |
0abf604d2a | ||
![]() |
ca51130286 | ||
![]() |
28e96deb73 | ||
![]() |
9173b6eaaa | ||
![]() |
492420d13f | ||
![]() |
d2ec492827 | ||
![]() |
d12cdc7a76 | ||
![]() |
a4f49ffb18 | ||
![]() |
6599912985 | ||
![]() |
b7ef39a61c | ||
![]() |
d4bf047b09 | ||
![]() |
9df3426f41 | ||
![]() |
d7f887c6f6 | ||
![]() |
25dfbb3ed3 | ||
![]() |
4e48065605 | ||
![]() |
929a86e6b7 | ||
![]() |
e0895d9751 | ||
![]() |
7a1925594b | ||
![]() |
913813c602 | ||
![]() |
4fb4b31635 | ||
![]() |
6aedfc9c6a | ||
![]() |
2cc9204d9d | ||
![]() |
76fe879066 | ||
![]() |
34b161d10f | ||
![]() |
5c0f47fdc8 | ||
![]() |
919b62adac | ||
![]() |
909ff6bc9e | ||
![]() |
9b053b876c | ||
![]() |
831568fde3 | ||
![]() |
54f06566ee | ||
![]() |
f52241f4fe | ||
![]() |
ea5ce16f3c | ||
![]() |
e1c23e003b | ||
![]() |
a018b2af25 | ||
![]() |
16a7cecdbe | ||
![]() |
091cc49b1d | ||
![]() |
5982b8132f | ||
![]() |
90d158d8c4 | ||
![]() |
a5b3a7b3a5 | ||
![]() |
feafd3c3a9 | ||
![]() |
3fe31f9655 | ||
![]() |
317302fd94 | ||
![]() |
7d03be11e6 | ||
![]() |
a8b834c71c | ||
![]() |
ca00426f0d | ||
![]() |
040441b7eb | ||
![]() |
edde8164d7 | ||
![]() |
7451687be5 | ||
![]() |
0d55ad9f24 | ||
![]() |
c225e86ef3 | ||
![]() |
cd5886be9e | ||
![]() |
a2e909e0b0 | ||
![]() |
a2c45081a3 | ||
![]() |
3d7c49db2e | ||
![]() |
d2ba6f827b | ||
![]() |
2137062559 | ||
![]() |
d08c23f668 | ||
![]() |
c04a0c1981 | ||
![]() |
c2484433e8 | ||
![]() |
c92af394eb | ||
![]() |
e82b4cce0c | ||
![]() |
ff5624951d | ||
![]() |
0d1aa334b3 | ||
![]() |
24979034a3 | ||
![]() |
d43a992efd | ||
![]() |
d913dbf00b | ||
![]() |
e3c3f8eb75 | ||
![]() |
4e6c437274 | ||
![]() |
3ae4c5ee97 | ||
![]() |
bce3d8ed83 | ||
![]() |
02f3b9cedc | ||
![]() |
0721243d82 | ||
![]() |
63fda8378e | ||
![]() |
0bd6257ef5 | ||
![]() |
cfec32ac11 | ||
![]() |
8f32d613d1 | ||
![]() |
7a46a47cea | ||
![]() |
a0e446dc2c | ||
![]() |
8938f4270d | ||
![]() |
25bd5ea47c | ||
![]() |
0bce0a9fb7 | ||
![]() |
f6aeed969c | ||
![]() |
088dd82bd3 | ||
![]() |
503554046c | ||
![]() |
419ad7bb86 | ||
![]() |
74e6367b30 | ||
![]() |
4c8e73af33 | ||
![]() |
73446e5580 | ||
![]() |
223ae24416 | ||
![]() |
4167cf1695 | ||
![]() |
cf98b4d067 | ||
![]() |
e0e694cda4 | ||
![]() |
40b36ef34b | ||
![]() |
d47adb99a2 | ||
![]() |
32b86d1183 | ||
![]() |
c17ac02c13 | ||
![]() |
ea6623349c | ||
![]() |
0d1b08e770 | ||
![]() |
868430b726 | ||
![]() |
d3330716ee | ||
![]() |
9799b9d6eb | ||
![]() |
092ee2f4a7 | ||
![]() |
9c0fca16bf | ||
![]() |
ac5521bffa | ||
![]() |
8634b1ecce | ||
![]() |
258040c345 | ||
![]() |
1cd93c131e |
@@ -1,3 +1,4 @@
|
|||||||
|
assets/js/color.js
|
||||||
assets/js/flexsearch.js
|
assets/js/flexsearch.js
|
||||||
assets/js/vendor
|
assets/js/vendor
|
||||||
node_modules
|
node_modules
|
||||||
|
5
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -27,8 +27,9 @@ If applicable, add a copy of Hugo's log messages.
|
|||||||
If applicable, add screenshots to help explain your problem.
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
**Environment (please complete the following information):**
|
**Environment (please complete the following information):**
|
||||||
- Host OS: [e.g. macOS Ventura 13.0]
|
- Hinode version: [e.g. v0.11.3]
|
||||||
- Node version: [e.g. node v18.10.0]
|
- Host OS: [e.g. macOS Ventura 13.3]
|
||||||
|
- Node version: [e.g. node v18.15.0]
|
||||||
- Hugo version: [e.g. hugo v0.109.0-47b12b83e636224e5e601813ff3e6790c191e371+extended darwin/amd64 BuildDate=2022-12-23T10:38:11Z VendorInfo=gohugoio]
|
- Hugo version: [e.g. hugo v0.109.0-47b12b83e636224e5e601813ff3e6790c191e371+extended darwin/amd64 BuildDate=2022-12-23T10:38:11Z VendorInfo=gohugoio]
|
||||||
- Browser: [e.g. Google Chrome Version 108.0.5359.124 (Official Build) (arm64)]
|
- Browser: [e.g. Google Chrome Version 108.0.5359.124 (Official Build) (arm64)]
|
||||||
|
|
||||||
|
43
.github/workflows/auto-merge.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Source: https://nicolasiensen.github.io/2022-07-23-automating-dependency-updates-with-dependabot-github-auto-merge-and-github-actions/
|
||||||
|
name: Dependabot auto-merge
|
||||||
|
on: pull_request_target
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
review-dependabot-pr:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
|
||||||
|
steps:
|
||||||
|
- name: Dependabot metadata
|
||||||
|
id: metadata
|
||||||
|
uses: dependabot/fetch-metadata@v1
|
||||||
|
with:
|
||||||
|
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
- name: Enable auto-merge for Dependabot PRs
|
||||||
|
run: gh pr merge --auto --merge "$PR_URL"
|
||||||
|
env:
|
||||||
|
PR_URL: ${{github.event.pull_request.html_url}}
|
||||||
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||||
|
- name: Approve patch and minor updates
|
||||||
|
if: ${{steps.dependabot-metadata.outputs.update-type == 'version-update:semver-patch' || steps.dependabot-metadata.outputs.update-type == 'version-update:semver-minor'}}
|
||||||
|
run: gh pr review $PR_URL --approve -b "I'm **approving** this pull request because **it includes a patch or minor update**"
|
||||||
|
env:
|
||||||
|
PR_URL: ${{github.event.pull_request.html_url}}
|
||||||
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||||
|
- name: Approve major updates of development dependencies
|
||||||
|
if: ${{steps.dependabot-metadata.outputs.update-type == 'version-update:semver-major' && steps.dependabot-metadata.outputs.dependency-type == 'direct:development'}}
|
||||||
|
run: gh pr review $PR_URL --approve -b "I'm **approving** this pull request because **it includes a major update of a dependency used only in development**"
|
||||||
|
env:
|
||||||
|
PR_URL: ${{github.event.pull_request.html_url}}
|
||||||
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||||
|
- name: Comment on major updates of non-development dependencies
|
||||||
|
if: ${{steps.dependabot-metadata.outputs.update-type == 'version-update:semver-major' && steps.dependabot-metadata.outputs.dependency-type == 'direct:production'}}
|
||||||
|
run: |
|
||||||
|
gh pr comment $PR_URL --body "I'm **not approving** this PR because **it includes a major update of a dependency used in production**"
|
||||||
|
gh pr edit $PR_URL --add-label "requires-manual-qa"
|
||||||
|
env:
|
||||||
|
PR_URL: ${{github.event.pull_request.html_url}}
|
||||||
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
3
.gitignore
vendored
@@ -3,4 +3,5 @@ resources/
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
.DS_store
|
.DS_store
|
||||||
.hugo_build.lock
|
.hugo_build.lock
|
||||||
|
hugo_stats.json
|
@@ -1,5 +1,8 @@
|
|||||||
assets/scss/common/_variables.scss
|
assets/scss/common/_variables.scss
|
||||||
assets/scss/components/_syntax.scss
|
assets/scss/components/_syntax-dark.scss
|
||||||
|
assets/scss/components/_syntax-light.scss
|
||||||
|
assets/scss/hotfix
|
||||||
assets/scss/vendor
|
assets/scss/vendor
|
||||||
|
assets/scss/theme/fonts.scss
|
||||||
assets/scss/app.scss
|
assets/scss/app.scss
|
||||||
node_modules
|
node_modules
|
||||||
|
@@ -2,10 +2,7 @@
|
|||||||
"extends": "stylelint-config-standard-scss",
|
"extends": "stylelint-config-standard-scss",
|
||||||
"rules": {
|
"rules": {
|
||||||
"no-empty-source": null,
|
"no-empty-source": null,
|
||||||
"indentation": 4,
|
|
||||||
"string-quotes": "double",
|
|
||||||
"scss/comment-no-empty": null,
|
"scss/comment-no-empty": null,
|
||||||
"max-line-length": null,
|
|
||||||
"scss/at-extend-no-missing-placeholder": null,
|
"scss/at-extend-no-missing-placeholder": null,
|
||||||
"scss/dollar-variable-colon-space-after": null,
|
"scss/dollar-variable-colon-space-after": null,
|
||||||
"scss/dollar-variable-empty-line-before": null,
|
"scss/dollar-variable-empty-line-before": null,
|
||||||
|
86
README.md
@@ -11,8 +11,8 @@
|
|||||||
<a href="https://gohugo.io" alt="Hugo website">
|
<a href="https://gohugo.io" alt="Hugo website">
|
||||||
<img src="https://img.shields.io/badge/generator-hugo-brightgreen" />
|
<img src="https://img.shields.io/badge/generator-hugo-brightgreen" />
|
||||||
</a>
|
</a>
|
||||||
<a href="https://app.netlify.com/sites/hinode-demo/deploys" alt="Netlify Status">
|
<a href="https://app.netlify.com/sites/gethinode-demo/deploys" alt="Netlify Status">
|
||||||
<img src="https://img.shields.io/netlify/151e88a3-d161-4045-856d-778fea43fc2f" />
|
<img src="https://img.shields.io/netlify/0ad42e3e-fdfa-4d37-8e26-58badd429a67" />
|
||||||
</a>
|
</a>
|
||||||
<a href="https://stats.uptimerobot.com/xyGVYhLJmV" alt="UptimeRobot Status">
|
<a href="https://stats.uptimerobot.com/xyGVYhLJmV" alt="UptimeRobot Status">
|
||||||
<img src="https://img.shields.io/uptimerobot/status/m791334689-73d9dfc82030f4f955b2d6bb" />
|
<img src="https://img.shields.io/uptimerobot/status/m791334689-73d9dfc82030f4f955b2d6bb" />
|
||||||
@@ -54,17 +54,16 @@ Hinode is a clean documentation and blog theme for [Hugo][hugo], an open-source
|
|||||||
|
|
||||||
Additional features include:
|
Additional features include:
|
||||||
|
|
||||||
- Comments
|
- Switching between light mode and dark mode
|
||||||
- Social links
|
- Support for multiple languages
|
||||||
- Blog pagination
|
- Reusable Bootstrap components through configurable shortcodes and partials
|
||||||
- Code highlighting
|
- Embedded comments through light-weight integration with GitHub via [utteranc.es][utterances]
|
||||||
- Command prompt
|
- Integrated sidebar navigation for content-heavy sections, such as documentation pages
|
||||||
- Color customization
|
- Reponsive image handling for multiple screen sizes and resolutions
|
||||||
- Language switcher
|
- Optimized search results, scoring 100 points for SEO on [PageSpeed Insights][pagespeed]
|
||||||
|
- Secure by default, scoring A+ on [Mozilla Observatory test][observatory]
|
||||||
|
|
||||||
<!-- TODO: add tutorial deep-link
|
Detailed information about Hinode is available on the [official website][website].
|
||||||
Detailed background information is available on the author's [personal blog][blog].
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
@@ -74,56 +73,39 @@ Hinode requires Git, Node.js and npm for local development and testing. Download
|
|||||||
|
|
||||||
Start a new Hinode project in three steps:
|
Start a new Hinode project in three steps:
|
||||||
|
|
||||||
### 1. Create a new site
|
1. Create a new site
|
||||||
|
|
||||||
Hinode is available as a [child theme][repository_child], and a [main theme][repository]. The child theme uses [npm][npm] to link to the latest available version of Hinode. As such, it is less applicable if you plan to customize a lot. Vice versa, the main theme allows for heavy customization, but is not synchronized with the latest available Hinode theme automatically.
|
Hinode is available as a [child theme][repository_child], and a [main theme][repository]. The child theme uses [npm][npm] to link to the latest available version of Hinode. Unless you plan to customize a lot, it is recommended to use the child theme:
|
||||||
|
|
||||||
Not quite sure? Use the Hinode child theme.
|
```bash
|
||||||
|
git clone https://github.com/gethinode/child.git my-hinode-site && cd my-hinode-site
|
||||||
|
```
|
||||||
|
|
||||||
#### Hinode child theme
|
Use the main theme if you intend to customize the base code:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/gethinode/child.git my-hinode-site && cd my-hinode-site
|
git clone https://github.com/gethinode/hinode.git my-hinode-site && cd my-hinode-site
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Hinode main theme
|
1. Install dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/gethinode/hinode.git my-hinode-site && cd my-hinode-site
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Install dependencies
|
1. Start development server
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Start development server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The main site configuration is available in `./config/_default`. Some remarks:
|
See the [official documentation][getstarted] on how to configure your site.
|
||||||
|
|
||||||
- **Menu items** - `menus/menus.en.toml` contains language-specific items for the navigation bar and social media links for the home page's footer.
|
|
||||||
- **Content** - Ensure the `mainSections` in `config.toml` is synchronized with the `content` folder, default values are `["blog", "projects"]`.
|
|
||||||
- **Theme style** - Update `primary` and `themeOpacity` within the `[style]` section of `params.toml` to update the site's primary color and opacity. Bootstrap's other key colors can be changed too. You can use the [WCAG Color Contrast Checker][contrast_checker] to validate the contrast ratio of your color to improve accessibility. Additionally, set `themeFont` and `themeFontPath` to override the default font.
|
|
||||||
- **Comments** - Comments are powered by [utterances][utterances], a lightweight comments widget built on GitHub issues. Update the `repo` of the `[comments]` section of `params.toml`.
|
|
||||||
- **Security policy** - The theme uses rather strict security policies by default. Be sure to include references to external sources in the header configuration to avoid broken links. The settings of the local development server are defined in `server.toml`. Similar settings are defined in the `netlify.toml` file provided in the repository's root when deploying to [Netlify][netlify].
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Clone the repository and create a new branch
|
See the [official documentation][contribute] on how to contribute to the open-source development of Hinode.
|
||||||
|
|
||||||
```console
|
|
||||||
git checkout https://github.com/gethinode/hinode.git -b name_for_new_branch
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Make and test the changes
|
|
||||||
3. Submit a Pull Request with a comprehensive description of the changes
|
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
@@ -144,7 +126,6 @@ The `hinode` and `child` codebase is released under the [MIT license][license].
|
|||||||
[blist]: https://github.com/apvarun/blist-hugo-theme
|
[blist]: https://github.com/apvarun/blist-hugo-theme
|
||||||
[bootstrap]: https://getbootstrap.com
|
[bootstrap]: https://getbootstrap.com
|
||||||
[cc-by-nc-4.0]: https://creativecommons.org/licenses/by-nc/4.0/
|
[cc-by-nc-4.0]: https://creativecommons.org/licenses/by-nc/4.0/
|
||||||
[contrast_checker]: https://accessibleweb.com/color-contrast-checker/
|
|
||||||
[doks]: https://github.com/h-enk/doks
|
[doks]: https://github.com/h-enk/doks
|
||||||
[flexsearch]: https://github.com/nextapps-de/flexsearch
|
[flexsearch]: https://github.com/nextapps-de/flexsearch
|
||||||
[git_download]: https://git-scm.com
|
[git_download]: https://git-scm.com
|
||||||
@@ -157,11 +138,10 @@ The `hinode` and `child` codebase is released under the [MIT license][license].
|
|||||||
[utterances]: https://utteranc.es
|
[utterances]: https://utteranc.es
|
||||||
|
|
||||||
<!-- MARKDOWN MAINTAINED LINKS -->
|
<!-- MARKDOWN MAINTAINED LINKS -->
|
||||||
<!-- TODO: add blog link
|
[contribute]: https://gethinode.com/contribute
|
||||||
[blog]: https://markdumay.com
|
[getstarted]: https://gethinode.com/docs
|
||||||
[blog]: https://github.com/markdumay
|
|
||||||
-->
|
|
||||||
[demo]: https://demo.gethinode.com/
|
[demo]: https://demo.gethinode.com/
|
||||||
[license]: https://github.com/gethinode/hinode/blob/main/LICENSE
|
[license]: https://github.com/gethinode/hinode/blob/main/LICENSE
|
||||||
[repository]: https://github.com/gethinode/hinode.git
|
[repository]: https://github.com/gethinode/hinode.git
|
||||||
[repository_child]: https://github.com/gethinode/child.git
|
[repository_child]: https://github.com/gethinode/child.git
|
||||||
|
[website]: https://gethinode.com/
|
||||||
|
3
assets/icons/accordion-button-active-icon-dark.svg
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='{{ .accordion_icon_active_color_dark }}'>
|
||||||
|
<path fill-rule='evenodd' d='M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z'/>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 269 B |
3
assets/icons/accordion-button-icon-dark.svg
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='{{ .accordion_icon_color_dark }}'>
|
||||||
|
<path fill-rule='evenodd' d='M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z'/>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 262 B |
3
assets/icons/btn-toggle-dark.svg
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 320 512' fill='{{ .btn_toggle_color_dark }}'>
|
||||||
|
<path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 314 B |
@@ -1,3 +1,3 @@
|
|||||||
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='{{ .carousel_control_color }} '>
|
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='{{ .carousel_control_color }}'>
|
||||||
<path d='M4.646 1.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1 0 .708l-6 6a.5.5 0 0 1-.708-.708L10.293 8 4.646 2.354a.5.5 0 0 1 0-.708z'/>
|
<path d='M4.646 1.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1 0 .708l-6 6a.5.5 0 0 1-.708-.708L10.293 8 4.646 2.354a.5.5 0 0 1 0-.708z'/>
|
||||||
</svg>
|
</svg>
|
Before Width: | Height: | Size: 240 B After Width: | Height: | Size: 239 B |
3
assets/icons/form-select-indicator-dark.svg
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'>
|
||||||
|
<path fill='none' stroke='{{ .form_select_indicator_color_dark }}' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m2 5 6 6 6-6'/>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 221 B |
3
assets/icons/form-switch-bg-image-dark.svg
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'>
|
||||||
|
<circle r='3' fill='{{ .form_switch_color_dark }}' />
|
||||||
|
</svg>
|
After Width: | Height: | Size: 125 B |
Before Width: | Height: | Size: 480 KiB |
Before Width: | Height: | Size: 396 KiB |
Before Width: | Height: | Size: 442 KiB |
Before Width: | Height: | Size: 476 KiB |
Before Width: | Height: | Size: 420 KiB |
Before Width: | Height: | Size: 183 KiB |
Before Width: | Height: | Size: 208 KiB |
Before Width: | Height: | Size: 229 KiB |
Before Width: | Height: | Size: 648 KiB |
Before Width: | Height: | Size: 325 KiB |
Before Width: | Height: | Size: 362 KiB |
Before Width: | Height: | Size: 290 KiB |
BIN
assets/img/paper.jpg
Normal file
After Width: | Height: | Size: 930 KiB |
18
assets/js/animation.js
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
function reveal () {
|
||||||
|
const reveals = document.querySelectorAll('.reveal')
|
||||||
|
|
||||||
|
for (let i = 0; i < reveals.length; i++) {
|
||||||
|
const windowHeight = window.innerHeight
|
||||||
|
const elementTop = reveals[i].getBoundingClientRect().top
|
||||||
|
const elementVisible = 150
|
||||||
|
|
||||||
|
if (elementTop < windowHeight - elementVisible) {
|
||||||
|
reveals[i].classList.add('active')
|
||||||
|
reveals[i].classList.remove('reveal')
|
||||||
|
} else {
|
||||||
|
reveals[i].classList.remove('active')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
window.addEventListener('scroll', reveal)
|
70
assets/js/critical/color.js
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
/*!
|
||||||
|
* Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
|
||||||
|
* Copyright 2011-2022 The Bootstrap Authors
|
||||||
|
* Licensed under the Creative Commons Attribution 3.0 Unported License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
(() => {
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
const storedTheme = localStorage.getItem('theme')
|
||||||
|
|
||||||
|
const getPreferredTheme = () => {
|
||||||
|
if (storedTheme) {
|
||||||
|
return storedTheme
|
||||||
|
}
|
||||||
|
|
||||||
|
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
|
||||||
|
}
|
||||||
|
|
||||||
|
const setTheme = function (theme) {
|
||||||
|
if (theme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||||||
|
document.documentElement.setAttribute('data-bs-theme', 'dark')
|
||||||
|
} else {
|
||||||
|
document.documentElement.setAttribute('data-bs-theme', theme)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
setTheme(getPreferredTheme())
|
||||||
|
|
||||||
|
const showActiveTheme = theme => {
|
||||||
|
const activeSelectors = document.querySelectorAll('.theme-icon-active')
|
||||||
|
const activeButtons = document.querySelectorAll(`[data-bs-theme-value="${theme}"]`)
|
||||||
|
if (activeButtons.length > 0) {
|
||||||
|
const activeIcon = activeButtons[0].querySelector('i')
|
||||||
|
|
||||||
|
document.querySelectorAll('[data-bs-theme-value]').forEach(element => {
|
||||||
|
element.classList.remove('active')
|
||||||
|
})
|
||||||
|
|
||||||
|
for (let i = 0; i < activeSelectors.length; ++i) {
|
||||||
|
activeSelectors[i].className = activeIcon.className
|
||||||
|
activeSelectors[i].className = activeSelectors[i].className.replace('theme-icon', 'theme-icon-active')
|
||||||
|
}
|
||||||
|
|
||||||
|
for (let i = 0; i < activeButtons.length; ++i) {
|
||||||
|
activeButtons[i].classList.add('active')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
|
||||||
|
if (storedTheme !== 'light' || storedTheme !== 'dark') {
|
||||||
|
setTheme(getPreferredTheme())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
window.addEventListener('DOMContentLoaded', () => {
|
||||||
|
showActiveTheme(getPreferredTheme())
|
||||||
|
|
||||||
|
document.querySelectorAll('[data-bs-theme-value]')
|
||||||
|
.forEach(toggle => {
|
||||||
|
toggle.addEventListener('click', () => {
|
||||||
|
const theme = toggle.getAttribute('data-bs-theme-value')
|
||||||
|
localStorage.setItem('theme', theme)
|
||||||
|
setTheme(theme)
|
||||||
|
showActiveTheme(theme)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})()
|
@@ -81,7 +81,7 @@ Source:
|
|||||||
// https://discourse.gohugo.io/t/range-length-or-last-element/3803/2
|
// https://discourse.gohugo.io/t/range-length-or-last-element/3803/2
|
||||||
// Note: uses .Site.AllPages as .Site.RegularPages only returns content for the current language
|
// Note: uses .Site.AllPages as .Site.RegularPages only returns content for the current language
|
||||||
// pages without a title (such as browserconfig.xml) are excluded
|
// pages without a title (such as browserconfig.xml) are excluded
|
||||||
{{ $list := where (where .Site.AllPages "Kind" "in" "page") "Title" "!=" "" }}
|
{{ $list := where (where site.AllPages "Kind" "in" "page") "Title" "!=" "" }}
|
||||||
{{ $len := (len $list) -}}
|
{{ $len := (len $list) -}}
|
||||||
|
|
||||||
index.add(
|
index.add(
|
||||||
|
24
assets/js/navbar.js
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
const navbar = document.querySelector('.navbar')
|
||||||
|
const toggler = document.getElementById('main-nav-toggler')
|
||||||
|
const modeSelectors = document.querySelectorAll('.switch-mode-collapsed')
|
||||||
|
|
||||||
|
// set the navbar background color to opaque when scrolling past a breakpoint
|
||||||
|
window.onscroll = () => {
|
||||||
|
if (window.scrollY > 75) {
|
||||||
|
navbar.classList.add('nav-active')
|
||||||
|
} else {
|
||||||
|
navbar.classList.remove('nav-active')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// set the navbar background color to opaque when expanded
|
||||||
|
toggler.onclick = () => {
|
||||||
|
navbar.classList.toggle('navbar-expanded')
|
||||||
|
}
|
||||||
|
|
||||||
|
// invoke the navbar toggler for each mode switcher to collapse the main menu afterwards
|
||||||
|
for (let i = 0; i < modeSelectors.length; ++i) {
|
||||||
|
modeSelectors[i].onclick = () => {
|
||||||
|
toggler.click()
|
||||||
|
}
|
||||||
|
}
|
@@ -1,17 +1,5 @@
|
|||||||
// Define template variables
|
// Define template variables
|
||||||
// TODO: optimize, see https://discourse.gohugo.io/t/initialize-sass-variables-from-hugo-templates/42053
|
@import "hugo:vars";
|
||||||
// requires installation of dart-sass, no cross-platform installation available yet
|
|
||||||
$themeColor: {{ site.Params.style.themeColor | default "#007bff" }};
|
|
||||||
$themeFont: {{ site.Params.style.themeFont | default "Inter" }};
|
|
||||||
$primary: {{ site.Params.style.primary | default "#007bff" }};
|
|
||||||
$secondary: {{ site.Params.style.secondary | default "#6c757d" }};
|
|
||||||
$success: {{ site.Params.style.success | default "#198754" }};
|
|
||||||
$info: {{ site.Params.style.info | default "#0dcaf0" }};
|
|
||||||
$warning: {{ site.Params.style.warning | default "#ffc107" }};
|
|
||||||
$danger: {{ site.Params.style.danger | default "#dc3545" }};
|
|
||||||
$light: {{ site.Params.style.light | default "#f8f9fa" }};
|
|
||||||
$dark: {{ site.Params.style.dark | default "#212529" }};
|
|
||||||
$navbar-offset: {{ if site.Params.navigation.fixed }}{{ site.Params.navigation.offset | default "4em" }}{{ else }}0em{{ end }};
|
|
||||||
|
|
||||||
// Include default variable overrides
|
// Include default variable overrides
|
||||||
@import "common/variables.scss";
|
@import "common/variables.scss";
|
||||||
@@ -24,6 +12,7 @@ $navbar-offset: {{ if site.Params.navigation.fixed }}{{ site.Par
|
|||||||
|
|
||||||
// Import Bootstrap configuration
|
// Import Bootstrap configuration
|
||||||
@import "bootstrap/scss/variables";
|
@import "bootstrap/scss/variables";
|
||||||
|
@import "bootstrap/scss/variables-dark.scss";
|
||||||
@import "bootstrap/scss/maps";
|
@import "bootstrap/scss/maps";
|
||||||
@import "bootstrap/scss/mixins";
|
@import "bootstrap/scss/mixins";
|
||||||
@import "bootstrap/scss/utilities";
|
@import "bootstrap/scss/utilities";
|
||||||
@@ -64,9 +53,6 @@ $navbar-offset: {{ if site.Params.navigation.fixed }}{{ site.Par
|
|||||||
// Import Bootstrap helpers
|
// Import Bootstrap helpers
|
||||||
@import "bootstrap/scss/helpers";
|
@import "bootstrap/scss/helpers";
|
||||||
|
|
||||||
// Import Bootstrap utilities
|
|
||||||
@import "bootstrap/scss/utilities/api";
|
|
||||||
|
|
||||||
// Import Font Awesome
|
// Import Font Awesome
|
||||||
// scss-docs-start awesome
|
// scss-docs-start awesome
|
||||||
@import "@fortawesome/fontawesome-free/scss/fontawesome";
|
@import "@fortawesome/fontawesome-free/scss/fontawesome";
|
||||||
@@ -85,14 +71,32 @@ $navbar-offset: {{ if site.Params.navigation.fixed }}{{ site.Par
|
|||||||
@import "components/comments.scss";
|
@import "components/comments.scss";
|
||||||
@import "components/navbar.scss";
|
@import "components/navbar.scss";
|
||||||
@import "components/img.scss";
|
@import "components/img.scss";
|
||||||
|
@import "components/persona.scss";
|
||||||
@import "components/popover.scss";
|
@import "components/popover.scss";
|
||||||
@import "components/search.scss";
|
@import "components/search.scss";
|
||||||
@import "components/sidebar.scss";
|
@import "components/sidebar.scss";
|
||||||
@import "components/syntax.scss";
|
@import "components/syntax.scss";
|
||||||
@import "components/toc.scss";
|
@import "components/toc.scss";
|
||||||
@import "components/vimeo.scss";
|
@import "components/vimeo.scss";
|
||||||
|
@import "common/animation.scss";
|
||||||
@import "common/styles.scss";
|
@import "common/styles.scss";
|
||||||
@import "layouts/reboot.scss";
|
@import "layouts/reboot.scss";
|
||||||
@import "layouts/type.scss";
|
@import "layouts/type.scss";
|
||||||
@import "common/export.scss";
|
@import "common/export.scss";
|
||||||
@import "helpers/colored-links.scss";
|
@import "helpers/colored-links.scss";
|
||||||
|
@import "helpers/display.scss";
|
||||||
|
|
||||||
|
// TODO: include fonts with following statement in Dart Sass
|
||||||
|
// @if $import-fonts {
|
||||||
|
// @include meta.load-css(theme/fonts);
|
||||||
|
// }
|
||||||
|
|
||||||
|
{{ if (not (hasPrefix (lower site.Params.style.themeFontPath) "http")) }}
|
||||||
|
@import "theme/fonts.scss";
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
// Import theme placeholder
|
||||||
|
@import "theme/theme.scss";
|
||||||
|
|
||||||
|
// Import Bootstrap utilities API
|
||||||
|
@import "bootstrap/scss/utilities/api";
|
||||||
|
99
assets/scss/common/_animation.scss
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
.rotate-5 {
|
||||||
|
transform: rotate(5deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.rotate-n5 {
|
||||||
|
transform: rotate(-5deg);
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: no-preference) {
|
||||||
|
.reveal {
|
||||||
|
position: relative;
|
||||||
|
opacity: 0;
|
||||||
|
animation-iteration-count: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.reveal.active {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.active.fade-bottom {
|
||||||
|
animation: fade-bottom 1s ease-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
.active.fade-bottom-5 {
|
||||||
|
animation: fade-bottom-5 1s ease-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
.active.fade-bottom-n5 {
|
||||||
|
animation: fade-bottom-n5 1s ease-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
.active.fade-left {
|
||||||
|
animation: fade-left 1s ease-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
.active.fade-right {
|
||||||
|
animation: fade-right 1s ease-in;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-bottom {
|
||||||
|
0% {
|
||||||
|
transform: translateY(50px);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
100% {
|
||||||
|
transform: translateY(0);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-bottom-5 {
|
||||||
|
0% {
|
||||||
|
transform: translateY(50px) rotate(5deg);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
100% {
|
||||||
|
transform: translateY(0) rotate(5deg);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-bottom-n5 {
|
||||||
|
0% {
|
||||||
|
transform: translateY(50px) rotate(-5deg);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
100% {
|
||||||
|
transform: translateY(0) rotate(-5deg);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-left {
|
||||||
|
0% {
|
||||||
|
transform: translateX(-100px);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
100% {
|
||||||
|
transform: translateX(0);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes fade-right {
|
||||||
|
0% {
|
||||||
|
transform: translateX(100px);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
100% {
|
||||||
|
transform: translateX(0);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@@ -3,20 +3,26 @@
|
|||||||
// scss-docs-start export
|
// scss-docs-start export
|
||||||
:hinode-theme {
|
:hinode-theme {
|
||||||
--accordion-icon-active-color: #{$accordion-icon-active-color};
|
--accordion-icon-active-color: #{$accordion-icon-active-color};
|
||||||
|
--accordion-icon-active-color-dark: #{$gray-300};
|
||||||
--accordion-icon-color: #{$accordion-icon-color};
|
--accordion-icon-color: #{$accordion-icon-color};
|
||||||
|
--accordion-icon-color-dark: #{$gray-600};
|
||||||
--btn-close-color: #{$btn-close-color};
|
--btn-close-color: #{$btn-close-color};
|
||||||
--btn-toggle-color: #{$btn-toggle-color};
|
--btn-toggle-color: #{$btn-toggle-color};
|
||||||
|
--btn-toggle-color-dark: #{$gray-600};
|
||||||
--carousel-control-color: #{$carousel-control-color};
|
--carousel-control-color: #{$carousel-control-color};
|
||||||
--form-check-input-checked-color: #{$form-check-input-checked-color};
|
--form-check-input-checked-color: #{$form-check-input-checked-color};
|
||||||
--form-check-input-indeterminate-color: #{$form-check-input-indeterminate-color};
|
--form-check-input-indeterminate-color: #{$form-check-input-indeterminate-color};
|
||||||
--form-feedback-icon-invalid-color: #{$form-feedback-icon-invalid-color};
|
--form-feedback-icon-invalid-color: #{$form-feedback-icon-invalid-color};
|
||||||
--form-feedback-icon-valid-color: #{$form-feedback-icon-valid-color};
|
--form-feedback-icon-valid-color: #{$form-feedback-icon-valid-color};
|
||||||
--form-select-indicator-color: #{$form-select-indicator-color};
|
--form-select-indicator-color: #{$form-select-indicator-color};
|
||||||
|
--form-select-indicator-color-dark: #{$form-select-indicator-color-dark};
|
||||||
--form-switch-checked-color: #{$form-switch-checked-color};
|
--form-switch-checked-color: #{$form-switch-checked-color};
|
||||||
--form-switch-color: #{$form-switch-color};
|
--form-switch-color: #{$form-switch-color};
|
||||||
|
--form-switch-color-dark: #{$form-switch-color-dark};
|
||||||
--form-switch-focus-color: #{$form-switch-focus-color};
|
--form-switch-focus-color: #{$form-switch-focus-color};
|
||||||
--navbar-dark-color: #{$navbar-dark-color};
|
--navbar-dark-color: #{$navbar-dark-color};
|
||||||
--navbar-light-icon-color: rgba($body-color, 0.75); // TODO: See https://github.com/twbs/bootstrap/pull/37720
|
--navbar-light-icon-color: rgba($body-color, 0.75); // TODO: See https://github.com/twbs/bootstrap/pull/37720
|
||||||
}
|
}
|
||||||
|
|
||||||
// scss-docs-end export
|
// scss-docs-end export
|
||||||
|
// stylelint-enable selector-pseudo-class-no-unknown
|
||||||
|
@@ -1,20 +1,25 @@
|
|||||||
// scss-docs-start icons
|
// scss-docs-start icons
|
||||||
$form-check-input-checked-bg-image: url("icons/form-check-input-checked-bg-image.svg") !default;
|
$form-check-input-checked-bg-image: url("/icons/form-check-input-checked-bg-image.svg") !default;
|
||||||
$form-check-radio-checked-bg-image: url("icons/form-check-radio-checked-bg-image.svg") !default;
|
$form-check-radio-checked-bg-image: url("/icons/form-check-radio-checked-bg-image.svg") !default;
|
||||||
$form-check-input-indeterminate-bg-image: url("icons/form-check-input-indeterminate-bg-image.svg") !default;
|
$form-check-input-indeterminate-bg-image: url("/icons/form-check-input-indeterminate-bg-image.svg") !default;
|
||||||
$form-switch-bg-image: url("icons/form-switch-bg-image.svg") !default;
|
$form-switch-bg-image: url("/icons/form-switch-bg-image.svg") !default;
|
||||||
$form-switch-focus-bg-image: url("icons/form-switch-focus-bg-image.svg") !default;
|
$form-switch-bg-image-dark: url("/icons/form-switch-bg-image-dark.svg") !default;
|
||||||
$form-switch-checked-bg-image: url("icons/form-switch-checked-bg-image.svg") !default;
|
$form-switch-focus-bg-image: url("/icons/form-switch-focus-bg-image.svg") !default;
|
||||||
$form-select-indicator: url("icons/form-select-indicator.svg") !default;
|
$form-switch-checked-bg-image: url("/icons/form-switch-checked-bg-image.svg") !default;
|
||||||
$form-feedback-icon-valid: url("icons/form-feedback-icon-valid.svg") !default;
|
$form-select-indicator: url("/icons/form-select-indicator.svg") !default;
|
||||||
$form-feedback-icon-invalid: url("icons/form-feedback-icon-invalid.svg") !default;
|
$form-select-indicator-dark: url("/icons/form-select-indicator-dark.svg") !default;
|
||||||
$navbar-light-toggler-icon-bg: url("icons/navbar-light-toggler-icon-bg.svg") !default;
|
$form-feedback-icon-valid: url("/icons/form-feedback-icon-valid.svg") !default;
|
||||||
$navbar-dark-toggler-icon-bg: url("icons/navbar-dark-toggler-icon-bg.svg") !default;
|
$form-feedback-icon-invalid: url("/icons/form-feedback-icon-invalid.svg") !default;
|
||||||
$accordion-button-icon: url("icons/accordion-button-icon.svg") !default;
|
$navbar-light-toggler-icon-bg: url("/icons/navbar-light-toggler-icon-bg.svg") !default;
|
||||||
$accordion-button-active-icon: url("icons/accordion-button-active-icon.svg") !default;
|
$navbar-dark-toggler-icon-bg: url("/icons/navbar-dark-toggler-icon-bg.svg") !default;
|
||||||
$carousel-control-prev-icon-bg: url("icons/carousel-control-prev-icon-bg.svg") !default;
|
$accordion-button-icon: url("/icons/accordion-button-icon.svg") !default;
|
||||||
$carousel-control-next-icon-bg: url("icons/carousel-control-next-icon-bg.svg") !default;
|
$accordion-button-icon-dark: url("/icons/accordion-button-icon-dark.svg") !default;
|
||||||
$btn-close-bg: url("icons/btn-close-bg.svg") !default;
|
$accordion-button-active-icon: url("/icons/accordion-button-active-icon.svg") !default;
|
||||||
$btn-toggle: url("icons/btn-toggle.svg") !default;
|
$accordion-button-active-icon-dark: url("/icons/accordion-button-active-icon-dark.svg") !default;
|
||||||
|
$carousel-control-prev-icon-bg: url("/icons/carousel-control-prev-icon-bg.svg") !default;
|
||||||
|
$carousel-control-next-icon-bg: url("/icons/carousel-control-next-icon-bg.svg") !default;
|
||||||
|
$btn-close-bg: url("/icons/btn-close-bg.svg") !default;
|
||||||
|
$btn-toggle: url("/icons/btn-toggle.svg") !default;
|
||||||
|
$btn-toggle-dark: url("/icons/btn-toggle-dark.svg") !default;
|
||||||
|
|
||||||
// scss-docs-end icons
|
// scss-docs-end icons
|
||||||
|
@@ -18,3 +18,132 @@ a:active {
|
|||||||
.tickmark li::marker {
|
.tickmark li::marker {
|
||||||
content: "✓ ";
|
content: "✓ ";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.anchor
|
||||||
|
{
|
||||||
|
color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.heading:hover .anchor
|
||||||
|
{
|
||||||
|
transition: 0.25s ease-in-out;
|
||||||
|
color: $primary;
|
||||||
|
}
|
||||||
|
|
||||||
|
$utilities: map-merge(
|
||||||
|
$utilities,
|
||||||
|
(
|
||||||
|
"padding-start-wide": (
|
||||||
|
property: padding-left,
|
||||||
|
responsive: true,
|
||||||
|
class: psw,
|
||||||
|
values: (
|
||||||
|
0: 0,
|
||||||
|
1: 1.5 * $spacer,
|
||||||
|
2: 3 * $spacer,
|
||||||
|
3: 6 * $spacer,
|
||||||
|
4: 9 * $spacer,
|
||||||
|
5: 12 * $spacer,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"padding-top-wide": (
|
||||||
|
property: padding-top,
|
||||||
|
responsive: true,
|
||||||
|
class: ptw,
|
||||||
|
values: (
|
||||||
|
0: 0,
|
||||||
|
1: 1.5 * $spacer,
|
||||||
|
2: 3 * $spacer,
|
||||||
|
3: 6 * $spacer,
|
||||||
|
4: 9 * $spacer,
|
||||||
|
5: 12 * $spacer,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"font-size": map-merge(
|
||||||
|
map-get($utilities, "font-size"),
|
||||||
|
( responsive: true ),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
@media screen and (orientation: portrait) {
|
||||||
|
.min-vh-custom {
|
||||||
|
min-height: 25vh !important
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (orientation: landscape) {
|
||||||
|
.min-vh-custom {
|
||||||
|
min-height: 50vh !important
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
:root {
|
||||||
|
--nav-height: 90px;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-breakpoint-up(sm) {
|
||||||
|
.ratio-section {
|
||||||
|
min-height: calc(min(100vh, 576px) - var(--nav-height));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-breakpoint-up(md) {
|
||||||
|
.ratio-section {
|
||||||
|
min-height: calc(min(100vh, 768px) - var(--nav-height));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-breakpoint-up(lg) {
|
||||||
|
.ratio-section {
|
||||||
|
min-height: calc(min(100vh, 992px) - var(--nav-height));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-breakpoint-up(xl) {
|
||||||
|
.ratio-section {
|
||||||
|
min-height: calc(min(100vh, 1200px) - var(--nav-height));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-breakpoint-up(xxl) {
|
||||||
|
.ratio-section {
|
||||||
|
min-height: calc(min(100vh, 1400px) - var(--nav-height));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$utilities: map-merge(
|
||||||
|
$utilities,
|
||||||
|
(
|
||||||
|
"padding-start-wide": (
|
||||||
|
property: padding-left,
|
||||||
|
responsive: true,
|
||||||
|
class: psw,
|
||||||
|
values: (
|
||||||
|
0: 0,
|
||||||
|
1: 1.5 * $spacer,
|
||||||
|
2: 3 * $spacer,
|
||||||
|
3: 6 * $spacer,
|
||||||
|
4: 9 * $spacer,
|
||||||
|
5: 12 * $spacer,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"padding-top-wide": (
|
||||||
|
property: padding-top,
|
||||||
|
responsive: true,
|
||||||
|
class: ptw,
|
||||||
|
values: (
|
||||||
|
0: 0,
|
||||||
|
1: 1.5 * $spacer,
|
||||||
|
2: 3 * $spacer,
|
||||||
|
3: 6 * $spacer,
|
||||||
|
4: 9 * $spacer,
|
||||||
|
5: 12 * $spacer,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"font-size": map-merge(
|
||||||
|
map-get($utilities, "font-size"),
|
||||||
|
( responsive: true ),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
@@ -1,5 +1,6 @@
|
|||||||
// Bootstrap variables overrides for theme
|
// Bootstrap variables overrides for theme
|
||||||
$enable-negative-margins: true;
|
$enable-negative-margins: true;
|
||||||
|
$enable-important-utilities: true !default;
|
||||||
|
|
||||||
// Font awesome variables overrides for theme
|
// Font awesome variables overrides for theme
|
||||||
$fa-font-path: "../fonts";
|
$fa-font-path: "../fonts";
|
||||||
@@ -8,7 +9,7 @@ $fa-font-path: "../fonts";
|
|||||||
$navbar-toggler-focus-width: 0 !default;
|
$navbar-toggler-focus-width: 0 !default;
|
||||||
|
|
||||||
// scss-docs-start font
|
// scss-docs-start font
|
||||||
$font-family-sans-serif: $themeFont, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji" !default;
|
$font-family-sans-serif: $theme-font, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji" !default;
|
||||||
$headings-font-weight: 600 !default;
|
$headings-font-weight: 600 !default;
|
||||||
$font-weight-lighter: lighter !default;
|
$font-weight-lighter: lighter !default;
|
||||||
$font-weight-light: 200 !default;
|
$font-weight-light: 200 !default;
|
||||||
@@ -17,9 +18,13 @@ $font-weight-bold: 600 !default;
|
|||||||
$font-weight-bolder: bolder !default;
|
$font-weight-bolder: bolder !default;
|
||||||
|
|
||||||
strong {
|
strong {
|
||||||
font-weight: 600 !important;
|
font-weight: 600 if($enable-important-utilities, !important, null);
|
||||||
}
|
}
|
||||||
// scss-docs-end font
|
// scss-docs-end font
|
||||||
|
|
||||||
$black: #000 !default;
|
$black: #000 !default;
|
||||||
$btn-toggle-color: $black !default;
|
$btn-toggle-color: $black !default;
|
||||||
|
|
||||||
|
$carousel-dark-indicator-active-bg: #ffffff !default;
|
||||||
|
$carousel-dark-caption-color: #ffffff !default;
|
||||||
|
$carousel-dark-control-icon-filter: invert(0) grayscale(100) !default;
|
||||||
|
@@ -4,5 +4,5 @@
|
|||||||
.btn-primary:active,
|
.btn-primary:active,
|
||||||
.btn-primary.active,
|
.btn-primary.active,
|
||||||
.open > .dropdown-toggle.btn-primary {
|
.open > .dropdown-toggle.btn-primary {
|
||||||
color: #fff !important;
|
color: #fff if($enable-important-utilities, !important, null);
|
||||||
}
|
}
|
||||||
|
@@ -6,16 +6,8 @@
|
|||||||
position: relative;
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
.card-img-wrap::after {
|
.card-zoom {
|
||||||
content: "";
|
cursor: pointer;
|
||||||
position: absolute;
|
|
||||||
top: 0;
|
|
||||||
left: 0;
|
|
||||||
right: 0;
|
|
||||||
bottom: 0;
|
|
||||||
background: rgba(255, 255, 255, 0.3);
|
|
||||||
opacity: 0;
|
|
||||||
transition: opacity 0.25s;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.card-img-wrap img {
|
.card-img-wrap img {
|
||||||
@@ -23,11 +15,21 @@
|
|||||||
width: 100%;
|
width: 100%;
|
||||||
}
|
}
|
||||||
|
|
||||||
.card-img-wrap:hover img {
|
.card-zoom::after .card-img-wrap img {
|
||||||
transform: scale(1.1);
|
content: "";
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
background: rgba(255, 255, 255, 0.3);
|
||||||
|
opacity: 0;
|
||||||
|
transition: opacity 0.25s;
|
||||||
}
|
}
|
||||||
|
|
||||||
.card-img-wrap:hover::after {
|
.card-zoom:hover .card-img-wrap img {
|
||||||
|
transform: scale(1.1);
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.card-zoom:hover::after .card-img-wrap img {
|
||||||
opacity: 1;
|
opacity: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -40,3 +42,32 @@
|
|||||||
transform: scale(1.01);
|
transform: scale(1.01);
|
||||||
box-shadow: 0 10px 20px rgba(0, 0, 0, 0.12), 0 4px 8px rgba(0, 0, 0, 0.06);
|
box-shadow: 0 10px 20px rgba(0, 0, 0, 0.12), 0 4px 8px rgba(0, 0, 0, 0.06);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// stylelint-disable annotation-no-unknown
|
||||||
|
.card-body-link {
|
||||||
|
color: $body-color if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
@if $enable-dark-mode {
|
||||||
|
@include color-mode(dark) {
|
||||||
|
.card-body-link {
|
||||||
|
color: $gray-500 if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.card-zoom card-body-link,
|
||||||
|
.card-body-link {
|
||||||
|
&:hover,
|
||||||
|
&:focus {
|
||||||
|
color: shade-color($primary, $link-shade-percentage) if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// stylelint-enable annotation-no-unknown
|
||||||
|
|
||||||
|
// make tag-link clickable on top of the stretched-link.
|
||||||
|
.card .tag-link {
|
||||||
|
z-index: 2;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
@@ -1,16 +1,35 @@
|
|||||||
|
// stylelint-disable annotation-no-unknown
|
||||||
|
|
||||||
// Source: https://jsfiddle.net/njhgr40m/
|
// Source: https://jsfiddle.net/njhgr40m/
|
||||||
|
|
||||||
|
.navbar {
|
||||||
|
transition: 0.5s ease-in-out;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.nav-active, .navbar-expanded {
|
||||||
|
background-color: var(--bs-body-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-expanded {
|
||||||
|
box-shadow: $box-shadow-sm;
|
||||||
|
}
|
||||||
|
|
||||||
/* Remove border from toggler */
|
/* Remove border from toggler */
|
||||||
.navbar-toggler {
|
.navbar-toggler {
|
||||||
border: 0 !important;
|
border: 0 if($enable-important-utilities, !important, null);
|
||||||
}
|
}
|
||||||
|
|
||||||
.navbar-toggler:focus,
|
.navbar-toggler:focus,
|
||||||
.navbar-toggler:active,
|
.navbar-toggler:active,
|
||||||
.navbar-toggler-icon:focus {
|
.navbar-toggler-icon:focus {
|
||||||
outline: none !important;
|
outline: none if($enable-important-utilities, !important, null);
|
||||||
box-shadow: none !important;
|
box-shadow: none if($enable-important-utilities, !important, null);
|
||||||
border: 0 !important;
|
border: 0 if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
.fw-30 {
|
||||||
|
width: 30px !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Lines of the Toggler */
|
/* Lines of the Toggler */
|
||||||
@@ -65,3 +84,17 @@
|
|||||||
.navbar-toggler.collapsed .toggler-icon {
|
.navbar-toggler.collapsed .toggler-icon {
|
||||||
background-color: #777;
|
background-color: #777;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.emphasis {
|
||||||
|
background-color: $black if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
@if $enable-dark-mode {
|
||||||
|
@include color-mode(dark) {
|
||||||
|
.emphasis {
|
||||||
|
background-color: $white if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// stylelint-enable annotation-no-unknown
|
||||||
|
3
assets/scss/components/_persona.scss
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
.persona {
|
||||||
|
min-height: 320px !important
|
||||||
|
}
|
@@ -11,7 +11,7 @@
|
|||||||
.form-control.is-search {
|
.form-control.is-search {
|
||||||
padding-right: 4rem;
|
padding-right: 4rem;
|
||||||
border: 1px solid transparent;
|
border: 1px solid transparent;
|
||||||
background: $gray-100;
|
background: var(--bs-tertiary-bg);
|
||||||
}
|
}
|
||||||
|
|
||||||
.form-control.is-search:focus {
|
.form-control.is-search:focus {
|
||||||
@@ -29,9 +29,9 @@
|
|||||||
padding-right: 0.3125rem;
|
padding-right: 0.3125rem;
|
||||||
padding-left: 0.3125rem;
|
padding-left: 0.3125rem;
|
||||||
font-size: $font-size-base * 0.75;
|
font-size: $font-size-base * 0.75;
|
||||||
color: $gray-700;
|
color: var(--bs-secondary-color);
|
||||||
content: "Ctrl + /";
|
content: "Ctrl + /";
|
||||||
border: 1px solid $gray-300;
|
border: 1px solid var(--bs-border-color);
|
||||||
border-radius: 0.25rem;
|
border-radius: 0.25rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,12 +59,12 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
#suggestions a:focus {
|
#suggestions a:focus {
|
||||||
background: $gray-100;
|
background-color: var(--bs-tertiary-bg);
|
||||||
outline: 0;
|
outline: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
#suggestions div:not(:first-child) {
|
#suggestions div:not(:first-child) {
|
||||||
border-top: 1px dashed $gray-200;
|
border-top: 1px dashed var(--bs-border-color);
|
||||||
}
|
}
|
||||||
|
|
||||||
#suggestions div:first-child {
|
#suggestions div:first-child {
|
||||||
@@ -76,7 +76,7 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
#suggestions a:hover {
|
#suggestions a:hover {
|
||||||
background: $gray-100;
|
background-color: var(--bs-tertiary-bg);
|
||||||
}
|
}
|
||||||
|
|
||||||
#suggestions span {
|
#suggestions span {
|
||||||
@@ -86,12 +86,11 @@
|
|||||||
|
|
||||||
.suggestion__title {
|
.suggestion__title {
|
||||||
font-weight: $headings-font-weight;
|
font-weight: $headings-font-weight;
|
||||||
color: $black;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.suggestion__description,
|
.suggestion__description,
|
||||||
.suggestion__no-results {
|
.suggestion__no-results {
|
||||||
color: $gray-700;
|
color: var(--bs-secondary-color);
|
||||||
}
|
}
|
||||||
|
|
||||||
@include media-breakpoint-up(sm) {
|
@include media-breakpoint-up(sm) {
|
||||||
@@ -106,7 +105,7 @@
|
|||||||
.suggestion__title {
|
.suggestion__title {
|
||||||
width: 9rem;
|
width: 9rem;
|
||||||
padding-right: 1rem;
|
padding-right: 1rem;
|
||||||
border-right: 1px solid $gray-200;
|
border-right: 1px solid var(--bs-border-color);
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
text-align: right;
|
text-align: right;
|
||||||
}
|
}
|
||||||
|
@@ -3,6 +3,25 @@
|
|||||||
top: $navbar-offset;
|
top: $navbar-offset;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.sidebar-overflow {
|
||||||
|
top: $navbar-offset;
|
||||||
|
max-height: 90vh;
|
||||||
|
overflow-y: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sidebar-item {
|
||||||
|
color: rgba(0, 0, 0, 0.65);
|
||||||
|
margin-left: 0 !important;
|
||||||
|
padding-left: 0.85rem !important;
|
||||||
|
display: inline-block;
|
||||||
|
|
||||||
|
&.active,
|
||||||
|
&:hover,
|
||||||
|
&:focus {
|
||||||
|
color: black;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
.btn-toggle {
|
.btn-toggle {
|
||||||
padding: 0.25rem 0.5rem;
|
padding: 0.25rem 0.5rem;
|
||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
@@ -11,7 +30,7 @@
|
|||||||
|
|
||||||
&:hover,
|
&:hover,
|
||||||
&:focus {
|
&:focus {
|
||||||
color: rgba(0, 0, 0, 0.85);
|
color: black;
|
||||||
background-color: tint-color($primary, 90%);
|
background-color: tint-color($primary, 90%);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -24,10 +43,8 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// scss-docs-end sidebar
|
|
||||||
|
|
||||||
.btn-toggle[aria-expanded="true"] {
|
.btn-toggle[aria-expanded="true"] {
|
||||||
color: rgba(0, 0, 0, 0.85);
|
color: black;
|
||||||
|
|
||||||
&::before {
|
&::before {
|
||||||
transform: rotate(90deg);
|
transform: rotate(90deg);
|
||||||
@@ -49,6 +66,58 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@if $enable-dark-mode {
|
||||||
|
@include color-mode(dark) {
|
||||||
|
.sidebar-item {
|
||||||
|
color: var(--bs-tertiary-color);
|
||||||
|
margin-left: 0 !important;
|
||||||
|
padding-left: 0.85rem !important;
|
||||||
|
|
||||||
|
&.active,
|
||||||
|
&:hover,
|
||||||
|
&:focus {
|
||||||
|
color: var(--bs-secondary-color);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-toggle {
|
||||||
|
color: var(--bs-tertiary-color);
|
||||||
|
|
||||||
|
&:hover,
|
||||||
|
&:focus {
|
||||||
|
color: $secondary;
|
||||||
|
background-color: tint-color($primary, 90%);
|
||||||
|
}
|
||||||
|
|
||||||
|
&::before {
|
||||||
|
content: $btn-toggle-dark;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-toggle[aria-expanded="true"] {
|
||||||
|
color: var(--bs-secondary-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-toggle-nav a {
|
||||||
|
padding: 0.1875rem 0.5rem;
|
||||||
|
margin-top: 0.125rem;
|
||||||
|
margin-left: 1.25rem;
|
||||||
|
|
||||||
|
&:hover,
|
||||||
|
&:focus {
|
||||||
|
color: $secondary;
|
||||||
|
background-color: tint-color($primary, 90%);
|
||||||
|
}
|
||||||
|
|
||||||
|
&.active {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// scss-docs-end sidebar
|
||||||
|
|
||||||
.dropdown-toggle {
|
.dropdown-toggle {
|
||||||
outline: 0;
|
outline: 0;
|
||||||
}
|
}
|
||||||
|
86
assets/scss/components/_syntax-dark.scss
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
/* Background */ .bg { color: #c9d1d9; background-color: #0d1117; }
|
||||||
|
/* PreWrapper */ .chroma { color: #c9d1d9; background-color: #0d1117; }
|
||||||
|
/* Other */ .chroma .x { }
|
||||||
|
/* Error */ .chroma .err { color: #f85149 }
|
||||||
|
/* CodeLine */ .chroma .cl { }
|
||||||
|
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||||
|
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||||
|
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||||
|
/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
|
||||||
|
/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #64686c }
|
||||||
|
/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #6e7681 }
|
||||||
|
/* Line */ .chroma .line { display: flex; }
|
||||||
|
/* Keyword */ .chroma .k { color: #ff7b72 }
|
||||||
|
/* KeywordConstant */ .chroma .kc { color: #79c0ff }
|
||||||
|
/* KeywordDeclaration */ .chroma .kd { color: #ff7b72 }
|
||||||
|
/* KeywordNamespace */ .chroma .kn { color: #ff7b72 }
|
||||||
|
/* KeywordPseudo */ .chroma .kp { color: #79c0ff }
|
||||||
|
/* KeywordReserved */ .chroma .kr { color: #ff7b72 }
|
||||||
|
/* KeywordType */ .chroma .kt { color: #ff7b72 }
|
||||||
|
/* Name */ .chroma .n { }
|
||||||
|
/* NameAttribute */ .chroma .na { }
|
||||||
|
/* NameBuiltin */ .chroma .nb { }
|
||||||
|
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||||
|
/* NameClass */ .chroma .nc { color: #f0883e; font-weight: bold }
|
||||||
|
/* NameConstant */ .chroma .no { color: #79c0ff; font-weight: bold }
|
||||||
|
/* NameDecorator */ .chroma .nd { color: #d2a8ff; font-weight: bold }
|
||||||
|
/* NameEntity */ .chroma .ni { color: #ffa657 }
|
||||||
|
/* NameException */ .chroma .ne { color: #f0883e; font-weight: bold }
|
||||||
|
/* NameFunction */ .chroma .nf { color: #d2a8ff; font-weight: bold }
|
||||||
|
/* NameFunctionMagic */ .chroma .fm { }
|
||||||
|
/* NameLabel */ .chroma .nl { color: #79c0ff; font-weight: bold }
|
||||||
|
/* NameNamespace */ .chroma .nn { color: #ff7b72 }
|
||||||
|
/* NameOther */ .chroma .nx { }
|
||||||
|
/* NameProperty */ .chroma .py { color: #79c0ff }
|
||||||
|
/* NameTag */ .chroma .nt { color: #7ee787 }
|
||||||
|
/* NameVariable */ .chroma .nv { color: #79c0ff }
|
||||||
|
/* NameVariableClass */ .chroma .vc { }
|
||||||
|
/* NameVariableGlobal */ .chroma .vg { }
|
||||||
|
/* NameVariableInstance */ .chroma .vi { }
|
||||||
|
/* NameVariableMagic */ .chroma .vm { }
|
||||||
|
/* Literal */ .chroma .l { color: #a5d6ff }
|
||||||
|
/* LiteralDate */ .chroma .ld { color: #79c0ff }
|
||||||
|
/* LiteralString */ .chroma .s { color: #a5d6ff }
|
||||||
|
/* LiteralStringAffix */ .chroma .sa { color: #79c0ff }
|
||||||
|
/* LiteralStringBacktick */ .chroma .sb { color: #a5d6ff }
|
||||||
|
/* LiteralStringChar */ .chroma .sc { color: #a5d6ff }
|
||||||
|
/* LiteralStringDelimiter */ .chroma .dl { color: #79c0ff }
|
||||||
|
/* LiteralStringDoc */ .chroma .sd { color: #a5d6ff }
|
||||||
|
/* LiteralStringDouble */ .chroma .s2 { color: #a5d6ff }
|
||||||
|
/* LiteralStringEscape */ .chroma .se { color: #79c0ff }
|
||||||
|
/* LiteralStringHeredoc */ .chroma .sh { color: #79c0ff }
|
||||||
|
/* LiteralStringInterpol */ .chroma .si { color: #a5d6ff }
|
||||||
|
/* LiteralStringOther */ .chroma .sx { color: #a5d6ff }
|
||||||
|
/* LiteralStringRegex */ .chroma .sr { color: #79c0ff }
|
||||||
|
/* LiteralStringSingle */ .chroma .s1 { color: #a5d6ff }
|
||||||
|
/* LiteralStringSymbol */ .chroma .ss { color: #a5d6ff }
|
||||||
|
/* LiteralNumber */ .chroma .m { color: #a5d6ff }
|
||||||
|
/* LiteralNumberBin */ .chroma .mb { color: #a5d6ff }
|
||||||
|
/* LiteralNumberFloat */ .chroma .mf { color: #a5d6ff }
|
||||||
|
/* LiteralNumberHex */ .chroma .mh { color: #a5d6ff }
|
||||||
|
/* LiteralNumberInteger */ .chroma .mi { color: #a5d6ff }
|
||||||
|
/* LiteralNumberIntegerLong */ .chroma .il { color: #a5d6ff }
|
||||||
|
/* LiteralNumberOct */ .chroma .mo { color: #a5d6ff }
|
||||||
|
/* Operator */ .chroma .o { color: #ff7b72; font-weight: bold }
|
||||||
|
/* OperatorWord */ .chroma .ow { color: #ff7b72; font-weight: bold }
|
||||||
|
/* Punctuation */ .chroma .p { }
|
||||||
|
/* Comment */ .chroma .c { color: #8b949e; font-style: italic }
|
||||||
|
/* CommentHashbang */ .chroma .ch { color: #8b949e; font-style: italic }
|
||||||
|
/* CommentMultiline */ .chroma .cm { color: #8b949e; font-style: italic }
|
||||||
|
/* CommentSingle */ .chroma .c1 { color: #8b949e; font-style: italic }
|
||||||
|
/* CommentSpecial */ .chroma .cs { color: #8b949e; font-weight: bold; font-style: italic }
|
||||||
|
/* CommentPreproc */ .chroma .cp { color: #8b949e; font-weight: bold; font-style: italic }
|
||||||
|
/* CommentPreprocFile */ .chroma .cpf { color: #8b949e; font-weight: bold; font-style: italic }
|
||||||
|
/* Generic */ .chroma .g { }
|
||||||
|
/* GenericDeleted */ .chroma .gd { color: #ffa198; background-color: #490202 }
|
||||||
|
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||||
|
/* GenericError */ .chroma .gr { color: #ffa198 }
|
||||||
|
/* GenericHeading */ .chroma .gh { color: #79c0ff; font-weight: bold }
|
||||||
|
/* GenericInserted */ .chroma .gi { color: #56d364; background-color: #0f5323 }
|
||||||
|
/* GenericOutput */ .chroma .go { color: #8b949e }
|
||||||
|
/* GenericPrompt */ .chroma .gp { color: #8b949e }
|
||||||
|
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||||
|
/* GenericSubheading */ .chroma .gu { color: #79c0ff }
|
||||||
|
/* GenericTraceback */ .chroma .gt { color: #ff7b72 }
|
||||||
|
/* GenericUnderline */ .chroma .gl { text-decoration: underline }
|
||||||
|
/* TextWhitespace */ .chroma .w { color: #6e7681 }
|
86
assets/scss/components/_syntax-light.scss
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
/* Background */ .bg { background-color: #ffffff; }
|
||||||
|
/* PreWrapper */ .chroma { background-color: #ffffff; }
|
||||||
|
/* Other */ .chroma .x { }
|
||||||
|
/* Error */ .chroma .err { color: #a61717; background-color: #e3d2d2 }
|
||||||
|
/* CodeLine */ .chroma .cl { }
|
||||||
|
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
||||||
|
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||||
|
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
||||||
|
/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
|
||||||
|
/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||||
|
/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||||
|
/* Line */ .chroma .line { display: flex; }
|
||||||
|
/* Keyword */ .chroma .k { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordConstant */ .chroma .kc { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordDeclaration */ .chroma .kd { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordNamespace */ .chroma .kn { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordPseudo */ .chroma .kp { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordReserved */ .chroma .kr { color: #000000; font-weight: bold }
|
||||||
|
/* KeywordType */ .chroma .kt { color: #445588; font-weight: bold }
|
||||||
|
/* Name */ .chroma .n { }
|
||||||
|
/* NameAttribute */ .chroma .na { color: #008080 }
|
||||||
|
/* NameBuiltin */ .chroma .nb { color: #0086b3 }
|
||||||
|
/* NameBuiltinPseudo */ .chroma .bp { color: #999999 }
|
||||||
|
/* NameClass */ .chroma .nc { color: #445588; font-weight: bold }
|
||||||
|
/* NameConstant */ .chroma .no { color: #008080 }
|
||||||
|
/* NameDecorator */ .chroma .nd { color: #3c5d5d; font-weight: bold }
|
||||||
|
/* NameEntity */ .chroma .ni { color: #800080 }
|
||||||
|
/* NameException */ .chroma .ne { color: #990000; font-weight: bold }
|
||||||
|
/* NameFunction */ .chroma .nf { color: #990000; font-weight: bold }
|
||||||
|
/* NameFunctionMagic */ .chroma .fm { }
|
||||||
|
/* NameLabel */ .chroma .nl { color: #990000; font-weight: bold }
|
||||||
|
/* NameNamespace */ .chroma .nn { color: #555555 }
|
||||||
|
/* NameOther */ .chroma .nx { }
|
||||||
|
/* NameProperty */ .chroma .py { }
|
||||||
|
/* NameTag */ .chroma .nt { color: #000080 }
|
||||||
|
/* NameVariable */ .chroma .nv { color: #008080 }
|
||||||
|
/* NameVariableClass */ .chroma .vc { color: #008080 }
|
||||||
|
/* NameVariableGlobal */ .chroma .vg { color: #008080 }
|
||||||
|
/* NameVariableInstance */ .chroma .vi { color: #008080 }
|
||||||
|
/* NameVariableMagic */ .chroma .vm { }
|
||||||
|
/* Literal */ .chroma .l { }
|
||||||
|
/* LiteralDate */ .chroma .ld { }
|
||||||
|
/* LiteralString */ .chroma .s { color: #dd1144 }
|
||||||
|
/* LiteralStringAffix */ .chroma .sa { color: #dd1144 }
|
||||||
|
/* LiteralStringBacktick */ .chroma .sb { color: #dd1144 }
|
||||||
|
/* LiteralStringChar */ .chroma .sc { color: #dd1144 }
|
||||||
|
/* LiteralStringDelimiter */ .chroma .dl { color: #dd1144 }
|
||||||
|
/* LiteralStringDoc */ .chroma .sd { color: #dd1144 }
|
||||||
|
/* LiteralStringDouble */ .chroma .s2 { color: #dd1144 }
|
||||||
|
/* LiteralStringEscape */ .chroma .se { color: #dd1144 }
|
||||||
|
/* LiteralStringHeredoc */ .chroma .sh { color: #dd1144 }
|
||||||
|
/* LiteralStringInterpol */ .chroma .si { color: #dd1144 }
|
||||||
|
/* LiteralStringOther */ .chroma .sx { color: #dd1144 }
|
||||||
|
/* LiteralStringRegex */ .chroma .sr { color: #009926 }
|
||||||
|
/* LiteralStringSingle */ .chroma .s1 { color: #dd1144 }
|
||||||
|
/* LiteralStringSymbol */ .chroma .ss { color: #990073 }
|
||||||
|
/* LiteralNumber */ .chroma .m { color: #009999 }
|
||||||
|
/* LiteralNumberBin */ .chroma .mb { color: #009999 }
|
||||||
|
/* LiteralNumberFloat */ .chroma .mf { color: #009999 }
|
||||||
|
/* LiteralNumberHex */ .chroma .mh { color: #009999 }
|
||||||
|
/* LiteralNumberInteger */ .chroma .mi { color: #009999 }
|
||||||
|
/* LiteralNumberIntegerLong */ .chroma .il { color: #009999 }
|
||||||
|
/* LiteralNumberOct */ .chroma .mo { color: #009999 }
|
||||||
|
/* Operator */ .chroma .o { color: #000000; font-weight: bold }
|
||||||
|
/* OperatorWord */ .chroma .ow { color: #000000; font-weight: bold }
|
||||||
|
/* Punctuation */ .chroma .p { }
|
||||||
|
/* Comment */ .chroma .c { color: #999988; font-style: italic }
|
||||||
|
/* CommentHashbang */ .chroma .ch { color: #999988; font-style: italic }
|
||||||
|
/* CommentMultiline */ .chroma .cm { color: #999988; font-style: italic }
|
||||||
|
/* CommentSingle */ .chroma .c1 { color: #999988; font-style: italic }
|
||||||
|
/* CommentSpecial */ .chroma .cs { color: #999999; font-weight: bold; font-style: italic }
|
||||||
|
/* CommentPreproc */ .chroma .cp { color: #999999; font-weight: bold; font-style: italic }
|
||||||
|
/* CommentPreprocFile */ .chroma .cpf { color: #999999; font-weight: bold; font-style: italic }
|
||||||
|
/* Generic */ .chroma .g { }
|
||||||
|
/* GenericDeleted */ .chroma .gd { color: #000000; background-color: #ffdddd }
|
||||||
|
/* GenericEmph */ .chroma .ge { color: #000000; font-style: italic }
|
||||||
|
/* GenericError */ .chroma .gr { color: #aa0000 }
|
||||||
|
/* GenericHeading */ .chroma .gh { color: #999999 }
|
||||||
|
/* GenericInserted */ .chroma .gi { color: #000000; background-color: #ddffdd }
|
||||||
|
/* GenericOutput */ .chroma .go { color: #888888 }
|
||||||
|
/* GenericPrompt */ .chroma .gp { color: #555555 }
|
||||||
|
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||||
|
/* GenericSubheading */ .chroma .gu { color: #aaaaaa }
|
||||||
|
/* GenericTraceback */ .chroma .gt { color: #aa0000 }
|
||||||
|
/* GenericUnderline */ .chroma .gl { text-decoration: underline }
|
||||||
|
/* TextWhitespace */ .chroma .w { color: #bbbbbb }
|
@@ -1,86 +1,40 @@
|
|||||||
/* Background */ .bg { color: #272822; }
|
// stylelint-disable annotation-no-unknown
|
||||||
/* PreWrapper */ .chroma { color: #272822 }
|
@import "syntax-light";
|
||||||
/* Other */ .chroma .x { }
|
|
||||||
/* Error */ .chroma .err { color: #960050 }
|
.bg,
|
||||||
/* CodeLine */ .chroma .cl { }
|
.chroma,
|
||||||
/* LineLink */ .chroma .lnlinks { outline: none; text-decoration: none; color: inherit }
|
.chroma .err {
|
||||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
// set to transparent background to avoid rendering issues with example shortcode
|
||||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; }
|
background-color: transparent if($enable-important-utilities, !important, null);
|
||||||
/* LineHighlight */ .chroma .hl { background-color: #ffffcc }
|
}
|
||||||
/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
|
||||||
/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
.syntax-highlight {
|
||||||
/* Line */ .chroma .line { display: flex; }
|
background-color: var(--bs-light) if($enable-important-utilities, !important, null);
|
||||||
/* Keyword */ .chroma .k { color: #00a8c8 }
|
}
|
||||||
/* KeywordConstant */ .chroma .kc { color: #00a8c8 }
|
|
||||||
/* KeywordDeclaration */ .chroma .kd { color: #00a8c8 }
|
.preview-background {
|
||||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
background-color: var(--bs-secondary-bg) if($enable-important-utilities, !important, null);
|
||||||
/* KeywordPseudo */ .chroma .kp { color: #00a8c8 }
|
}
|
||||||
/* KeywordReserved */ .chroma .kr { color: #00a8c8 }
|
|
||||||
/* KeywordType */ .chroma .kt { color: #00a8c8 }
|
@if $enable-dark-mode {
|
||||||
/* Name */ .chroma .n { color: #111111 }
|
[data-bs-theme="dark"] {
|
||||||
/* NameAttribute */ .chroma .na { color: #75af00 }
|
@import "syntax-dark"; // stylelint-disable-line no-invalid-position-at-import-rule
|
||||||
/* NameBuiltin */ .chroma .nb { color: #111111 }
|
|
||||||
/* NameBuiltinPseudo */ .chroma .bp { color: #111111 }
|
.bg,
|
||||||
/* NameClass */ .chroma .nc { color: #75af00 }
|
.chroma,
|
||||||
/* NameConstant */ .chroma .no { color: #00a8c8 }
|
.chroma .err {
|
||||||
/* NameDecorator */ .chroma .nd { color: #75af00 }
|
// set to transparent background to avoid rendering issues with example shortcode
|
||||||
/* NameEntity */ .chroma .ni { color: #111111 }
|
background-color: transparent if($enable-important-utilities, !important, null);
|
||||||
/* NameException */ .chroma .ne { color: #75af00 }
|
}
|
||||||
/* NameFunction */ .chroma .nf { color: #75af00 }
|
|
||||||
/* NameFunctionMagic */ .chroma .fm { color: #111111 }
|
.syntax-highlight {
|
||||||
/* NameLabel */ .chroma .nl { color: #111111 }
|
background-color: var(--bs-tertiary-bg) if($enable-important-utilities, !important, null);
|
||||||
/* NameNamespace */ .chroma .nn { color: #111111 }
|
}
|
||||||
/* NameOther */ .chroma .nx { color: #75af00 }
|
|
||||||
/* NameProperty */ .chroma .py { color: #111111 }
|
.bg,
|
||||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
.chroma {
|
||||||
/* NameVariable */ .chroma .nv { color: #111111 }
|
color: #c9d1d9 if($enable-important-utilities, !important, null);
|
||||||
/* NameVariableClass */ .chroma .vc { color: #111111 }
|
}
|
||||||
/* NameVariableGlobal */ .chroma .vg { color: #111111 }
|
}
|
||||||
/* NameVariableInstance */ .chroma .vi { color: #111111 }
|
}
|
||||||
/* NameVariableMagic */ .chroma .vm { color: #111111 }
|
// stylelint-enable annotation-no-unknown
|
||||||
/* Literal */ .chroma .l { color: #ae81ff }
|
|
||||||
/* LiteralDate */ .chroma .ld { color: #d88200 }
|
|
||||||
/* LiteralString */ .chroma .s { color: #d88200 }
|
|
||||||
/* LiteralStringAffix */ .chroma .sa { color: #d88200 }
|
|
||||||
/* LiteralStringBacktick */ .chroma .sb { color: #d88200 }
|
|
||||||
/* LiteralStringChar */ .chroma .sc { color: #d88200 }
|
|
||||||
/* LiteralStringDelimiter */ .chroma .dl { color: #d88200 }
|
|
||||||
/* LiteralStringDoc */ .chroma .sd { color: #d88200 }
|
|
||||||
/* LiteralStringDouble */ .chroma .s2 { color: #d88200 }
|
|
||||||
/* LiteralStringEscape */ .chroma .se { color: #8045ff }
|
|
||||||
/* LiteralStringHeredoc */ .chroma .sh { color: #d88200 }
|
|
||||||
/* LiteralStringInterpol */ .chroma .si { color: #d88200 }
|
|
||||||
/* LiteralStringOther */ .chroma .sx { color: #d88200 }
|
|
||||||
/* LiteralStringRegex */ .chroma .sr { color: #d88200 }
|
|
||||||
/* LiteralStringSingle */ .chroma .s1 { color: #d88200 }
|
|
||||||
/* LiteralStringSymbol */ .chroma .ss { color: #d88200 }
|
|
||||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
|
||||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
|
||||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
|
||||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
|
||||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
|
||||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
|
||||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
|
||||||
/* Operator */ .chroma .o { color: #f92672 }
|
|
||||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
|
||||||
/* Punctuation */ .chroma .p { color: #111111 }
|
|
||||||
/* Comment */ .chroma .c { color: #75715e }
|
|
||||||
/* CommentHashbang */ .chroma .ch { color: #75715e }
|
|
||||||
/* CommentMultiline */ .chroma .cm { color: #75715e }
|
|
||||||
/* CommentSingle */ .chroma .c1 { color: #75715e }
|
|
||||||
/* CommentSpecial */ .chroma .cs { color: #75715e }
|
|
||||||
/* CommentPreproc */ .chroma .cp { color: #75715e }
|
|
||||||
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
|
|
||||||
/* Generic */ .chroma .g { }
|
|
||||||
/* GenericDeleted */ .chroma .gd { }
|
|
||||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
|
||||||
/* GenericError */ .chroma .gr { }
|
|
||||||
/* GenericHeading */ .chroma .gh { }
|
|
||||||
/* GenericInserted */ .chroma .gi { }
|
|
||||||
/* GenericOutput */ .chroma .go { }
|
|
||||||
/* GenericPrompt */ .chroma .gp { }
|
|
||||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
|
||||||
/* GenericSubheading */ .chroma .gu { }
|
|
||||||
/* GenericTraceback */ .chroma .gt { }
|
|
||||||
/* GenericUnderline */ .chroma .gl { }
|
|
||||||
/* TextWhitespace */ .chroma .w { }
|
|
||||||
|
@@ -6,9 +6,9 @@
|
|||||||
grid-area: toc;
|
grid-area: toc;
|
||||||
right: 0;
|
right: 0;
|
||||||
z-index: 2;
|
z-index: 2;
|
||||||
height: calc(100vh - 7rem);
|
height: calc(100vh - 5rem);
|
||||||
overflow-y: auto;
|
overflow-y: auto;
|
||||||
top: $navbar-offset;
|
top: 5rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
// scss-docs-end toc
|
// scss-docs-end toc
|
||||||
|
@@ -1,19 +1,37 @@
|
|||||||
// stylelint-disable function-name-case
|
|
||||||
|
|
||||||
// scss-docs-start colored-links
|
// scss-docs-start colored-links
|
||||||
@each $color, $value in $theme-colors {
|
$custom-colors: (
|
||||||
$contrast-color: color-contrast($value);
|
"primary": "light",
|
||||||
$color-rgb: to-rgb($value);
|
"secondary": "light",
|
||||||
|
"success": "light",
|
||||||
|
"danger": "light",
|
||||||
|
"dark": "light",
|
||||||
|
"black": "light",
|
||||||
|
"info": "dark",
|
||||||
|
"warning": "dark",
|
||||||
|
"light": "dark",
|
||||||
|
"white": "dark",
|
||||||
|
"body": "adaptive",
|
||||||
|
"body-tertiary": "adaptive"
|
||||||
|
);
|
||||||
|
|
||||||
|
@each $color, $value in $custom-colors {
|
||||||
|
$main-color: var(--bs-body-color);
|
||||||
|
$emphasize-color: var(--bs-secondary-color);
|
||||||
|
|
||||||
|
@if $value == "light" {
|
||||||
|
$main-color: $white;
|
||||||
|
$emphasize-color: shade-color($main-color, $link-shade-percentage);
|
||||||
|
} @else if $value == "dark" {
|
||||||
|
$main-color: $black;
|
||||||
|
$emphasize-color: tint-color($main-color, $link-shade-percentage);
|
||||||
|
}
|
||||||
|
|
||||||
.link-bg-#{$color} {
|
.link-bg-#{$color} {
|
||||||
color: $contrast-color !important; // stylelint-disable-line declaration-no-important
|
color: $main-color if($enable-important-utilities, !important, null);
|
||||||
background-color: RGBA($color-rgb, var(--#{$prefix}bg-opacity, 1)) if($enable-important-utilities, !important, null); // stylelint-disable-line annotation-no-unknown
|
|
||||||
|
|
||||||
@if $link-shade-percentage != 0 {
|
&:hover,
|
||||||
&:hover,
|
&:focus {
|
||||||
&:focus {
|
color: $emphasize-color if($enable-important-utilities, !important, null);
|
||||||
color: if($contrast-color == $color-contrast-light, shade-color($contrast-color, $link-shade-percentage), tint-color($contrast-color, $link-shade-percentage)) !important; // stylelint-disable-line declaration-no-important
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
30
assets/scss/helpers/_display.scss
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
.hidden {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
// stylelint-disable annotation-no-unknown
|
||||||
|
|
||||||
|
// scss-docs-start display-color
|
||||||
|
.d-none-light {
|
||||||
|
display: none if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
.d-none-dark {
|
||||||
|
display: block if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
@if $enable-dark-mode {
|
||||||
|
@include color-mode(dark) {
|
||||||
|
.d-none-light {
|
||||||
|
display: block if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
.d-none-dark {
|
||||||
|
display: none if($enable-important-utilities, !important, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// scss-docs-end display-color
|
||||||
|
|
||||||
|
// stylelint-enable annotation-no-unknown
|
62
assets/scss/theme/fonts.scss
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
/*!
|
||||||
|
* Copyright (c) 2016-2020 The Inter Project Authors.
|
||||||
|
* "Inter" is trademark of Rasmus Andersson.
|
||||||
|
* https://github.com/rsms/inter
|
||||||
|
|
||||||
|
* This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||||
|
* This license is copied below, and is also available with a FAQ at:
|
||||||
|
* http://scripts.sil.org/OFL
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* inter-200 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
|
||||||
|
font-family: 'Inter';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 200;
|
||||||
|
src: url('../fonts/inter-v12-latin-200.eot'); /* IE9 Compat Modes */
|
||||||
|
src: url('../fonts/inter-v12-latin-200.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||||
|
url('../fonts/inter-v12-latin-200.woff2') format('woff2'), /* Super Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-200.woff') format('woff'), /* Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-200.ttf') format('truetype'), /* Safari, Android, iOS */
|
||||||
|
url('../fonts/inter-v12-latin-200.svg#Inter') format('svg'); /* Legacy iOS */
|
||||||
|
}
|
||||||
|
/* inter-300 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
|
||||||
|
font-family: 'Inter';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 300;
|
||||||
|
src: url('../fonts/inter-v12-latin-300.eot'); /* IE9 Compat Modes */
|
||||||
|
src: url('../fonts/inter-v12-latin-300.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||||
|
url('../fonts/inter-v12-latin-300.woff2') format('woff2'), /* Super Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-300.woff') format('woff'), /* Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-300.ttf') format('truetype'), /* Safari, Android, iOS */
|
||||||
|
url('../fonts/inter-v12-latin-300.svg#Inter') format('svg'); /* Legacy iOS */
|
||||||
|
}
|
||||||
|
/* inter-regular - latin */
|
||||||
|
@font-face {
|
||||||
|
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
|
||||||
|
font-family: 'Inter';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
src: url('../fonts/inter-v12-latin-regular.eot'); /* IE9 Compat Modes */
|
||||||
|
src: url('../fonts/inter-v12-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||||
|
url('../fonts/inter-v12-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-regular.woff') format('woff'), /* Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */
|
||||||
|
url('../fonts/inter-v12-latin-regular.svg#Inter') format('svg'); /* Legacy iOS */
|
||||||
|
}
|
||||||
|
/* inter-600 - latin */
|
||||||
|
@font-face {
|
||||||
|
font-display: swap; /* Check https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display for other options. */
|
||||||
|
font-family: 'Inter';
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 600;
|
||||||
|
src: url('../fonts/inter-v12-latin-600.eot'); /* IE9 Compat Modes */
|
||||||
|
src: url('../fonts/inter-v12-latin-600.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
|
||||||
|
url('../fonts/inter-v12-latin-600.woff2') format('woff2'), /* Super Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-600.woff') format('woff'), /* Modern Browsers */
|
||||||
|
url('../fonts/inter-v12-latin-600.ttf') format('truetype'), /* Safari, Android, iOS */
|
||||||
|
url('../fonts/inter-v12-latin-600.svg#Inter') format('svg'); /* Legacy iOS */
|
||||||
|
}
|
2
assets/scss/theme/theme.scss
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
// Placeholder to quickly add your own styles
|
||||||
|
// The file is included last in the build pipeline
|
@@ -1,25 +0,0 @@
|
|||||||
---
|
|
||||||
label: Blog post
|
|
||||||
hide_body: false
|
|
||||||
fields:
|
|
||||||
- type: text
|
|
||||||
name: author
|
|
||||||
label: author
|
|
||||||
- type: text
|
|
||||||
name: title
|
|
||||||
label: title
|
|
||||||
- type: text
|
|
||||||
name: description
|
|
||||||
label: description
|
|
||||||
- type: list
|
|
||||||
name: tags
|
|
||||||
label: tags
|
|
||||||
- type: datetime
|
|
||||||
name: date
|
|
||||||
label: date
|
|
||||||
- type: file
|
|
||||||
name: thumbnail
|
|
||||||
label: thumbnail
|
|
||||||
- type: textarea
|
|
||||||
name: credits
|
|
||||||
label: credits
|
|
@@ -1,25 +0,0 @@
|
|||||||
---
|
|
||||||
label: Project
|
|
||||||
hide_body: false
|
|
||||||
fields:
|
|
||||||
- type: text
|
|
||||||
name: author
|
|
||||||
label: author
|
|
||||||
- type: text
|
|
||||||
name: title
|
|
||||||
label: title
|
|
||||||
- type: datetime
|
|
||||||
name: date
|
|
||||||
label: date
|
|
||||||
- type: text
|
|
||||||
name: description
|
|
||||||
label: description
|
|
||||||
- type: list
|
|
||||||
name: tags
|
|
||||||
label: tags
|
|
||||||
- type: file
|
|
||||||
name: thumbnail
|
|
||||||
label: thumbnail
|
|
||||||
- type: textarea
|
|
||||||
name: credits
|
|
||||||
label: credits
|
|
@@ -1,40 +0,0 @@
|
|||||||
---
|
|
||||||
new_page_extension: md
|
|
||||||
auto_deploy: false
|
|
||||||
admin_path:
|
|
||||||
webhook_url:
|
|
||||||
sections:
|
|
||||||
- type: directory
|
|
||||||
path: content/en/blog
|
|
||||||
label: Blog
|
|
||||||
create: all
|
|
||||||
match: "**/*"
|
|
||||||
templates:
|
|
||||||
- blog-post
|
|
||||||
- type: directory
|
|
||||||
path: content/en/projects
|
|
||||||
label: Projects
|
|
||||||
create: all
|
|
||||||
match: "**/*"
|
|
||||||
templates:
|
|
||||||
- project
|
|
||||||
- type: document
|
|
||||||
path: content/en/about.md
|
|
||||||
label: About
|
|
||||||
upload_dir: assets/img
|
|
||||||
public_path: "/img"
|
|
||||||
front_matter_path: ''
|
|
||||||
use_front_matter_path: false
|
|
||||||
file_template: ":filename:"
|
|
||||||
build:
|
|
||||||
preview_env:
|
|
||||||
- HUGO_ENV=staging
|
|
||||||
- HUGO_VERSION=0.92.2
|
|
||||||
- HUGO_ENABLEGITINFO=true
|
|
||||||
preview_output_directory: public
|
|
||||||
install_dependencies_command: npm install
|
|
||||||
preview_docker_image: forestryio/hugo:node16
|
|
||||||
mount_path: "/srv"
|
|
||||||
working_dir: "/srv"
|
|
||||||
instant_preview_command: npm run start
|
|
||||||
version: 0.81.0
|
|
@@ -16,9 +16,9 @@ enableInlineShortcodes = true
|
|||||||
# See https://github.com/gohugoio/hugo/issues/7228#issuecomment-714490456
|
# See https://github.com/gohugoio/hugo/issues/7228#issuecomment-714490456
|
||||||
ignoreErrors = ["error-remote-getjson"]
|
ignoreErrors = ["error-remote-getjson"]
|
||||||
|
|
||||||
# toml-docs-start build
|
# toml-docs-start timeout
|
||||||
timeout = "60s"
|
timeout = "180s"
|
||||||
# toml-docs-end build
|
# toml-docs-end timeout
|
||||||
|
|
||||||
# toml-docs-start language
|
# toml-docs-start language
|
||||||
languageCode = "en-us"
|
languageCode = "en-us"
|
||||||
@@ -26,6 +26,11 @@ defaultContentLanguage = "en"
|
|||||||
defaultContentLanguageInSubdir = true
|
defaultContentLanguageInSubdir = true
|
||||||
# toml-docs-end language
|
# toml-docs-end language
|
||||||
|
|
||||||
|
# toml-docs-start build
|
||||||
|
[build]
|
||||||
|
writeStats = true
|
||||||
|
# toml-docs-end build
|
||||||
|
|
||||||
[taxonomies]
|
[taxonomies]
|
||||||
tag = 'tags'
|
tag = 'tags'
|
||||||
|
|
||||||
|
@@ -8,8 +8,6 @@
|
|||||||
[en.params.head]
|
[en.params.head]
|
||||||
tagline = "A Hugo Theme"
|
tagline = "A Hugo Theme"
|
||||||
[en.params.feature]
|
[en.params.feature]
|
||||||
message = "Welcome to Hinode!"
|
|
||||||
tagline = "A clean documentation and blog theme for your Hugo site based on Bootstrap 5."
|
|
||||||
link = "/en/about"
|
link = "/en/about"
|
||||||
caption = "About"
|
caption = "About"
|
||||||
[en.params.footer]
|
[en.params.footer]
|
||||||
@@ -25,8 +23,6 @@
|
|||||||
[nl.params.head]
|
[nl.params.head]
|
||||||
tagline = "Een Hugo Thema"
|
tagline = "Een Hugo Thema"
|
||||||
[nl.params.feature]
|
[nl.params.feature]
|
||||||
message = "Welkom bij Hinode!"
|
|
||||||
tagline = "Een documentatie en blog thema voor Hugo gebaseerd op Bootstrap 5."
|
|
||||||
link = "/nl/over-mij"
|
link = "/nl/over-mij"
|
||||||
caption = "Over mij"
|
caption = "Over mij"
|
||||||
[nl.params.footer]
|
[nl.params.footer]
|
||||||
|
@@ -3,20 +3,15 @@
|
|||||||
url = "/about/"
|
url = "/about/"
|
||||||
weight = 10
|
weight = 10
|
||||||
|
|
||||||
[[main]]
|
|
||||||
name = "Docs"
|
|
||||||
url = "/docs/"
|
|
||||||
weight = 20
|
|
||||||
|
|
||||||
[[main]]
|
[[main]]
|
||||||
name = "Blog"
|
name = "Blog"
|
||||||
url = "/blog/"
|
url = "/blog/"
|
||||||
weight = 30
|
weight = 20
|
||||||
|
|
||||||
[[main]]
|
[[main]]
|
||||||
name = "Projects"
|
name = "Projects"
|
||||||
url = "/projects/"
|
url = "/projects/"
|
||||||
weight = 40
|
weight = 30
|
||||||
|
|
||||||
[[main]]
|
[[main]]
|
||||||
name = "Sample project"
|
name = "Sample project"
|
||||||
@@ -33,7 +28,7 @@
|
|||||||
[[main]]
|
[[main]]
|
||||||
name = "Tags"
|
name = "Tags"
|
||||||
url = "/tags/"
|
url = "/tags/"
|
||||||
weight = 50
|
weight = 40
|
||||||
|
|
||||||
[[social]]
|
[[social]]
|
||||||
name = "LinkedIn"
|
name = "LinkedIn"
|
||||||
|
@@ -46,4 +46,28 @@
|
|||||||
name = "Medium"
|
name = "Medium"
|
||||||
pre = "<i class=\"fab fa-medium fa-2x\"></i>"
|
pre = "<i class=\"fab fa-medium fa-2x\"></i>"
|
||||||
url = "https://medium.com/"
|
url = "https://medium.com/"
|
||||||
weight = 30
|
weight = 30
|
||||||
|
|
||||||
|
# toml-docs-start sample-navigation
|
||||||
|
[[sample]]
|
||||||
|
name = "Blog"
|
||||||
|
url = "/blog/"
|
||||||
|
weight = 10
|
||||||
|
|
||||||
|
[[sample]]
|
||||||
|
name = "Projecten"
|
||||||
|
url = "/projecten/"
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[sample]]
|
||||||
|
name = "Voorbeeldproject"
|
||||||
|
url = "/nl/projecten/voorbeeldproject/"
|
||||||
|
parent = "Projecten"
|
||||||
|
weight = 1
|
||||||
|
|
||||||
|
[[sample]]
|
||||||
|
name = "Ander project"
|
||||||
|
url = "/nl/projecten/ander-project/"
|
||||||
|
parent = "Projecten"
|
||||||
|
weight = 2
|
||||||
|
# toml-docs-end sample-navigation
|
@@ -2,11 +2,14 @@
|
|||||||
[main]
|
[main]
|
||||||
separator = "-"
|
separator = "-"
|
||||||
description = "Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5."
|
description = "Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5."
|
||||||
|
enableDarkMode = true
|
||||||
|
modes = ["light", "dark"]
|
||||||
# toml-docs-end main
|
# toml-docs-end main
|
||||||
|
|
||||||
# toml-docs-start docs
|
# toml-docs-start docs
|
||||||
[docs]
|
[docs]
|
||||||
version = "0.8"
|
version = "0.8"
|
||||||
|
basePath = ""
|
||||||
# toml-docs-end docs
|
# toml-docs-end docs
|
||||||
|
|
||||||
# toml-docs-start home
|
# toml-docs-start home
|
||||||
@@ -14,48 +17,52 @@
|
|||||||
sections = ["blog", "projects"]
|
sections = ["blog", "projects"]
|
||||||
featurePhoto = "/img/sunrise.jpg" # source: https://unsplash.com/photos/ZX6BPboJrYk
|
featurePhoto = "/img/sunrise.jpg" # source: https://unsplash.com/photos/ZX6BPboJrYk
|
||||||
fullCover = false
|
fullCover = false
|
||||||
|
centerHeadline = false
|
||||||
|
style = ""
|
||||||
# toml-docs-end home
|
# toml-docs-end home
|
||||||
|
|
||||||
# toml-docs-start navigation
|
# toml-docs-start navigation
|
||||||
[navigation]
|
[navigation]
|
||||||
logo = "/img/logo_embedded.svg"
|
anchor = true
|
||||||
color = "white"
|
logo = "/img/logo_icon.svg"
|
||||||
style = "light"
|
color = "body"
|
||||||
fixed = true
|
fixed = true
|
||||||
offset = "4em"
|
offset = "3.8em"
|
||||||
search = true
|
search = true
|
||||||
breadcrumb = false
|
breadcrumb = false
|
||||||
toc = true
|
toc = true
|
||||||
sidebar = true
|
sidebar = true
|
||||||
# toml-docs-end navigation
|
# toml-docs-end navigation
|
||||||
|
|
||||||
# toml-docs-start list
|
# toml-docs-start sections
|
||||||
[list]
|
[sections]
|
||||||
[blog]
|
[sections.blog]
|
||||||
title = "Blog"
|
title = "Blog"
|
||||||
sort = "date"
|
sort = "date"
|
||||||
reverse = false
|
reverse = true
|
||||||
cols = 3
|
cols = 3
|
||||||
color = ""
|
color = ""
|
||||||
padding = "0"
|
padding = "0"
|
||||||
header = "full"
|
header = "full"
|
||||||
footer = "none"
|
footer = "none"
|
||||||
orientation = "stacked"
|
orientation = "stacked"
|
||||||
style = "border-0"
|
style = "border-0 card-zoom"
|
||||||
homepage = 3
|
homepage = 3
|
||||||
[projects]
|
separator = true
|
||||||
|
[sections.projects]
|
||||||
title = "Projects"
|
title = "Projects"
|
||||||
sort = "title"
|
sort = "title"
|
||||||
reverse = false
|
reverse = false
|
||||||
cols = 1
|
cols = 1
|
||||||
color = ""
|
color = "body-tertiary"
|
||||||
padding = "3"
|
padding = "3"
|
||||||
header = "none"
|
header = "none"
|
||||||
footer = "tags"
|
footer = "tags"
|
||||||
orientation = "none"
|
orientation = "none"
|
||||||
style = "border-1 card-emphasize"
|
style = "border-1 card-emphasize"
|
||||||
homepage = 3
|
homepage = 3
|
||||||
# toml-docs-end list
|
separator = false
|
||||||
|
# toml-docs-end sections
|
||||||
|
|
||||||
[favicon]
|
[favicon]
|
||||||
logo = "img/favicon.png"
|
logo = "img/favicon.png"
|
||||||
@@ -63,7 +70,7 @@
|
|||||||
|
|
||||||
# toml-docs-start theme-colors
|
# toml-docs-start theme-colors
|
||||||
[style]
|
[style]
|
||||||
primary = "#D43900"
|
primary = "#d43900"
|
||||||
secondary = "#6c757d"
|
secondary = "#6c757d"
|
||||||
success = "#198754"
|
success = "#198754"
|
||||||
info = "#0dcaf0"
|
info = "#0dcaf0"
|
||||||
@@ -75,8 +82,12 @@
|
|||||||
themeOpacity = "10"
|
themeOpacity = "10"
|
||||||
# toml-docs-start font
|
# toml-docs-start font
|
||||||
themeFont = "Inter"
|
themeFont = "Inter"
|
||||||
themeFontPath = "https://fonts.googleapis.com/css2?family=Inter:wght@200;300;600&display=swap"
|
# themeFontPath = "https://fonts.googleapis.com/css2?family=Inter:wght@200;300;600&display=swap" # external path
|
||||||
|
themeFontPath = "/fonts" # local path
|
||||||
# toml-docs-end font
|
# toml-docs-end font
|
||||||
|
# toml-docs-start build
|
||||||
|
purge = false
|
||||||
|
# toml-docs-end build
|
||||||
|
|
||||||
[schema]
|
[schema]
|
||||||
type = "Organization"
|
type = "Organization"
|
||||||
@@ -114,78 +125,11 @@
|
|||||||
#theme = ""
|
#theme = ""
|
||||||
|
|
||||||
[links]
|
[links]
|
||||||
azure = "https://azure.microsoft.com"
|
|
||||||
az_blob_domain = "https://learn.microsoft.com/en-us/azure/storage/blobs/storage-custom-domain-name"
|
|
||||||
az_blob_pricing = "https://azure.microsoft.com/en-us/free"
|
|
||||||
az_cdn_rules = "https://learn.microsoft.com/en-us/azure/cdn/cdn-standard-rules-engine-reference"
|
|
||||||
blist = "https://github.com/apvarun/blist-hugo-theme"
|
|
||||||
bootstrap = "https://getbootstrap.com"
|
|
||||||
bs_badge_heading = "https://getbootstrap.com/docs/5.2/components/badge/#headings"
|
bs_badge_heading = "https://getbootstrap.com/docs/5.2/components/badge/#headings"
|
||||||
bs_breakpoints = "https://getbootstrap.com/docs/5.3/layout/breakpoints"
|
hinode_docs = "https://gethinode.com/docs"
|
||||||
bs_grid = "https://getbootstrap.com/docs/5.3/layout/grid"
|
|
||||||
bs_offcanvas = "https://getbootstrap.com/docs/5.3/components/offcanvas"
|
|
||||||
bs_navbar_placement = "https://getbootstrap.com/docs/5.3/components/navbar/#placement"
|
|
||||||
bs_tables = "https://getbootstrap.com/docs/5.3/content/tables"
|
|
||||||
cc_by_nc_4_0 = "https://creativecommons.org/licenses/by-nc/4.0/"
|
|
||||||
commit_message = "https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"
|
|
||||||
contrast_checker = "https://accessibleweb.com/color-contrast-checker/"
|
|
||||||
css_codeguide = "https://codeguide.co/#css"
|
|
||||||
doks = "https://github.com/h-enk/doks"
|
|
||||||
eslint = "https://eslint.org"
|
|
||||||
flexsearch = "https://github.com/nextapps-de/flexsearch"
|
|
||||||
fontawesome = "https://fontawesome.com"
|
|
||||||
fa_icons = "https://fontawesome.com/icons"
|
|
||||||
fa_styling = "https://fontawesome.com/docs/web/style/styling"
|
|
||||||
fa_animation = "https://fontawesome.com/docs/web/style/animate"
|
|
||||||
git_download = "https://git-scm.com"
|
|
||||||
github_pr = "https://help.github.com/articles/about-pull-requests/"
|
|
||||||
github_rebase = "https://help.github.com/articles/about-git-rebase/"
|
|
||||||
google_fonts = "https://fonts.google.com"
|
|
||||||
html_codeguide = "https://codeguide.co/#html"
|
|
||||||
hugo = "https://gohugo.io"
|
|
||||||
hugo_config = "https://gohugo.io/getting-started/configuration/#all-configuration-settings"
|
|
||||||
hugo_config_dir = "https://gohugo.io/getting-started/configuration/#configuration-directory"
|
|
||||||
hugo_content = "https://gohugo.io/content-management/formats"
|
|
||||||
hugo_chroma = "https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages"
|
|
||||||
hugo_deploy = "https://gohugo.io/hosting-and-deployment/hugo-deploy"
|
|
||||||
hugo_deployment = "https://gohugo.io/hosting-and-deployment"
|
|
||||||
hugo_config_deploy = "https://gohugo.io/hosting-and-deployment/hugo-deploy/#configure-the-deployment"
|
|
||||||
hugo_fingerprint = "https://gohugo.io/hugo-pipes/fingerprint"
|
|
||||||
hugo_frontmatter = "https://gohugo.io/content-management/front-matter"
|
|
||||||
hugo_i18n = "https://gohugo.io/functions/i18n"
|
|
||||||
hugo_image = "https://gohugo.io/content-management/image-processing"
|
|
||||||
hugo_lang = "https://gohugo.io/content-management/multilingual"
|
|
||||||
hugo_lang_config = "https://gohugo.io/content-management/multilingual/#configure-languages"
|
|
||||||
hugo_links = "https://gohugo.io/content-management/cross-references"
|
|
||||||
hugo_menus = "https://gohugo.io/content-management/menus/"
|
|
||||||
hugo_mounts = "https://gohugo.io/hugo-modules/configuration/#module-config-mounts"
|
|
||||||
hugo_imaging = "https://gohugo.io/content-management/image-processing/#imaging-configuration"
|
hugo_imaging = "https://gohugo.io/content-management/image-processing/#imaging-configuration"
|
||||||
hugo_ordering = "https://gohugo.io/templates/lists/#order-content"
|
|
||||||
hugo_templates = "https://gohugo.io/templates/introduction/"
|
|
||||||
hugo_toc = "https://gohugo.io/content-management/toc"
|
|
||||||
issue_tracker = "https://github.com/gethinode/hinode/issues"
|
|
||||||
license = "https://github.com/gethinode/hinode/blob/main/LICENSE"
|
|
||||||
markdown_emoji = "https://gist.github.com/rxaviers/7360908"
|
|
||||||
markdown_md013 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length"
|
|
||||||
markdown_md024 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024---multiple-headings-with-the-same-content"
|
|
||||||
markdown_md026 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md026---trailing-punctuation-in-heading"
|
|
||||||
markdown_md033 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033---inline-html"
|
|
||||||
markdown_md034 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md034---bare-url-used"
|
|
||||||
markdown_md051 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md051---link-fragments-should-be-valid"
|
|
||||||
markdown_md053 = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md053---link-and-image-reference-definitions-should-be-needed"
|
|
||||||
markdown_rules = "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md"
|
|
||||||
markdownlint = "https://github.com/DavidAnson/markdownlint-cli2"
|
|
||||||
mozilla_image = "https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images"
|
mozilla_image = "https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images"
|
||||||
netlify = "https://www.netlify.com"
|
|
||||||
nodejs = "https://nodejs.org"
|
|
||||||
npm = "https://www.npmjs.com"
|
|
||||||
observatory = "https://observatory.mozilla.org/analyze/demo.gethinode.com"
|
observatory = "https://observatory.mozilla.org/analyze/demo.gethinode.com"
|
||||||
package_npm = "https://www.npmjs.com/package/@gethinode/hinode"
|
|
||||||
pagespeed = "https://pagespeed.web.dev/report?url=https%3A%2F%2Fdemo.gethinode.com%2F"
|
pagespeed = "https://pagespeed.web.dev/report?url=https%3A%2F%2Fdemo.gethinode.com%2F"
|
||||||
repository = "https://github.com/gethinode/hinode"
|
|
||||||
repository_child = "https://github.com/gethinode/child.git"
|
|
||||||
repository_owner = "https://github.com/gethinode/"
|
|
||||||
semver = "https://semver.org"
|
|
||||||
stylelint = "https://stylelint.io"
|
|
||||||
utterances = "https://utteranc.es"
|
utterances = "https://utteranc.es"
|
||||||
wcag_contrast = "https://www.w3.org/TR/WCAG20/#visual-audio-contrast"
|
|
@@ -32,6 +32,11 @@ for = '/**'
|
|||||||
fullscreen=(), \
|
fullscreen=(), \
|
||||||
payment=() \
|
payment=() \
|
||||||
"""
|
"""
|
||||||
Cache-Control = "public, max-age=31536000"
|
cache-control = """\
|
||||||
|
max-age=0, \
|
||||||
|
no-cache, \
|
||||||
|
no-store, \
|
||||||
|
must-revalidate \
|
||||||
|
"""
|
||||||
Access-Control-Allow-Origin = "*"
|
Access-Control-Allow-Origin = "*"
|
||||||
# toml-docs-end server-config
|
# toml-docs-end server-config
|
@@ -1,47 +1,40 @@
|
|||||||
const autoprefixer = require('autoprefixer');
|
const autoprefixer = require('autoprefixer')({})
|
||||||
const purgecss = require('@fullhuman/postcss-purgecss');
|
const cssnano = require('cssnano')({
|
||||||
const whitelister = require('purgecss-whitelister');
|
preset: 'advanced'
|
||||||
|
})
|
||||||
|
const whitelister = require('purgecss-whitelister')
|
||||||
|
const purgecss = require('@fullhuman/postcss-purgecss')({
|
||||||
|
content: ['./hugo_stats.json'],
|
||||||
|
defaultExtractor: (content) => {
|
||||||
|
const els = JSON.parse(content).htmlElements
|
||||||
|
return [...(els.tags || []), ...(els.classes || []), ...(els.ids || [])]
|
||||||
|
},
|
||||||
|
dynamicAttributes: ['data-bs-theme'],
|
||||||
|
safelist: [
|
||||||
|
...whitelister([
|
||||||
|
'./assets/scss/components/_clipboard.scss',
|
||||||
|
'./assets/scss/components/_command.scss',
|
||||||
|
'./assets/scss/components/_navbar.scss',
|
||||||
|
'./assets/scss/components/_search.scss',
|
||||||
|
'./assets/scss/components/_syntax.scss',
|
||||||
|
'./assets/scss/components/_syntax-dark.scss',
|
||||||
|
'./assets/scss/components/_syntax-light.scss',
|
||||||
|
'./assets/scss/theme/fonts.scss',
|
||||||
|
'./assets/scss/theme/theme.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_carousel.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_dropdown.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_reboot.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_tooltip.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_transitions.scss',
|
||||||
|
'./node_modules/bootstrap/scss/_utilities.scss'
|
||||||
|
])
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
plugins: [
|
plugins: [
|
||||||
autoprefixer(),
|
autoprefixer,
|
||||||
purgecss({
|
cssnano,
|
||||||
content: [
|
purgecss
|
||||||
'./layouts/**/*.html',
|
]
|
||||||
'./content/**/*.md',
|
|
||||||
],
|
|
||||||
safelist: [
|
|
||||||
/lazyloaded/,
|
|
||||||
/table/,
|
|
||||||
/thead/,
|
|
||||||
/tbody/,
|
|
||||||
/tr/,
|
|
||||||
/th/,
|
|
||||||
/td/,
|
|
||||||
/h5/,
|
|
||||||
/alert-link/,
|
|
||||||
/container-xxl/,
|
|
||||||
/container-fluid/,
|
|
||||||
/^bg-opacity-\d+/,
|
|
||||||
/svg.*/,
|
|
||||||
/fa.*/,
|
|
||||||
/ratio.*/,
|
|
||||||
/suggestion.*/,
|
|
||||||
...whitelister([
|
|
||||||
'./assets/scss/components/_blockquote.scss',
|
|
||||||
'./assets/scss/components/_buttons.scss',
|
|
||||||
'./assets/scss/components/_card.scss',
|
|
||||||
'./assets/scss/components/_clipboard.scss',
|
|
||||||
'./assets/scss/components/_img.scss',
|
|
||||||
'./assets/scss/components/_navbar.scss',
|
|
||||||
'./assets/scss/components/_search.scss',
|
|
||||||
'./assets/scss/components/_syntax.scss',
|
|
||||||
'./assets/scss/layouts/_reboot.scss',
|
|
||||||
'./assets/scss/layouts/type.scss',
|
|
||||||
'./node_modules/bootstrap/scss/_dropdown.scss',
|
|
||||||
'./node_modules/bootstrap/scss/_utilities.scss',
|
|
||||||
]),
|
|
||||||
],
|
|
||||||
}),
|
|
||||||
],
|
|
||||||
}
|
}
|
||||||
|
@@ -1,4 +1,6 @@
|
|||||||
---
|
---
|
||||||
author: Mark Dumay
|
author: Mark Dumay
|
||||||
title: A Clean Theme for Hugo
|
title: Welcome to Hinode!
|
||||||
---
|
---
|
||||||
|
|
||||||
|
A clean documentation and blog theme for your Hugo site based on Bootstrap 5.
|
||||||
|
@@ -2,11 +2,11 @@
|
|||||||
title: About
|
title: About
|
||||||
description: Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5.
|
description: Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5.
|
||||||
date: 2022-04-11
|
date: 2022-04-11
|
||||||
updated: 2023-01-14
|
updated: 2023-02-11
|
||||||
showComments: false
|
showComments: false
|
||||||
---
|
---
|
||||||
|
|
||||||
<p class="text-center"><img src="/img/logo_embedded.svg" class="img-fluid w-50" alt="Logo"></p>
|
<p class="text-center"><svg class="img-fluid w-50"><use href="/img/logo_var.svg#logo"></use></svg></p>
|
||||||
|
|
||||||
<section class="section section-sm mt-5 mb-5">
|
<section class="section section-sm mt-5 mb-5">
|
||||||
<div class="container-fluid">
|
<div class="container-fluid">
|
||||||
@@ -32,6 +32,7 @@ showComments: false
|
|||||||
|
|
||||||
Additional features include:
|
Additional features include:
|
||||||
|
|
||||||
|
* Switching between light mode and dark mode
|
||||||
* Support for multiple languages
|
* Support for multiple languages
|
||||||
* Reusable Bootstrap components through configurable shortcodes and partials
|
* Reusable Bootstrap components through configurable shortcodes and partials
|
||||||
* Embedded comments through light-weight integration with GitHub via [utteranc.es]({{< param "links.utterances" >}})
|
* Embedded comments through light-weight integration with GitHub via [utteranc.es]({{< param "links.utterances" >}})
|
||||||
|
264
content/en/blog/bootstrap-elements.md
Normal file
@@ -0,0 +1,264 @@
|
|||||||
|
---
|
||||||
|
author: Mark Dumay
|
||||||
|
title: Bootstrap elements
|
||||||
|
date: 2023-02-17
|
||||||
|
description: Use shortcodes to add common Bootstrap elements with ease.
|
||||||
|
tags: ["bootstrap", "shortcode"]
|
||||||
|
thumbnail: img/boots.jpg
|
||||||
|
photoCredits: <a href="https://unsplash.com/@nate_dumlao">Nathan Dumlao</a>
|
||||||
|
photoSource: <a href="https://unsplash.com/photos/QLPWQvHvmII">Unsplash</a>
|
||||||
|
---
|
||||||
|
|
||||||
|
Hinode provides several shortcodes that wrap common Bootstrap components. Refer to the [official documentation]({{< param "links.hinode_docs" >}}) for more details.
|
||||||
|
|
||||||
|
## Accordion
|
||||||
|
|
||||||
|
As an example, the following shortcode displays an accordion with three elements, of which the first element is expanded.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* accordion */>}}
|
||||||
|
{{</* accordion-item header="Accordion Item #1" show="true" */>}}
|
||||||
|
This is the first item's accordion body. It supports HTML content. The item is shown by adding the value
|
||||||
|
<code>show</code> to the <code>class</code> argument.
|
||||||
|
{{</* /accordion-item */>}}
|
||||||
|
{{</* accordion-item header="Accordion Item #2" */>}}
|
||||||
|
This is the second item's accordion body. It supports HTML content too.
|
||||||
|
{{</* /accordion-item */>}}
|
||||||
|
{{</* accordion-item header="Accordion Item #3" */>}}
|
||||||
|
This is the third item's accordion body.
|
||||||
|
{{</* /accordion-item */>}}
|
||||||
|
{{</* /accordion */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Alert
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a simple alert.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* alert color="danger" dismissible="true" */>}}
|
||||||
|
A simple danger alert—check it out!
|
||||||
|
{{</* /alert */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Badge
|
||||||
|
|
||||||
|
Use HTML code to display a badge for a heading. See the Bootstrap [documentation]({{< param "links.bs_badge_heading" >}}) for more options.
|
||||||
|
|
||||||
|
{{< example >}}
|
||||||
|
<h1>Example heading of size one <span class="badge bg-secondary">New</span></h1>
|
||||||
|
<h2>Example heading of size two <span class="badge bg-secondary">New</span></h2>
|
||||||
|
<h3>Example heading of size three <span class="badge bg-secondary">New</span></h3>
|
||||||
|
<h4>Example heading of size four <span class="badge bg-secondary">New</span></h4>
|
||||||
|
<h5>Example heading of size five <span class="badge bg-secondary">New</span></h5>
|
||||||
|
<h6>Example heading of size six <span class="badge bg-secondary">New</span></h6>
|
||||||
|
{{< /example >}}
|
||||||
|
|
||||||
|
## Breadcrumb
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a breadcrumb for the blog page.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* breadcrumb path="blog" */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Button
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a tooltip for a dark button with a badge.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* button color="secondary" tooltip="Click on the inbox to view your unread messages" href="#!" badge="99+" */>}}
|
||||||
|
Inbox
|
||||||
|
{{</* /button */>}}
|
||||||
|
{{< /example>}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Button group
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a group of three buttons.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* button-group aria-label="Basic example" */>}}
|
||||||
|
{{</* button color="primary" href="#!" */>}}Left{{</* /button */>}}
|
||||||
|
{{</* button color="primary" href="#!" */>}}Middle{{</* /button */>}}
|
||||||
|
{{</* button color="primary" href="#!" */>}}Right{{</* /button */>}}
|
||||||
|
{{</* /button-group */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Card
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a stacked card that links to the [about]({{< ref "about" >}}) page. It includes a custom header.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* card path="about" padding="3" class="w-50" color="body-tertiary" header="publication" footer="none" */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Carousel
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a centered carousel with three slides, 16x9 aspect ratio, and a relative width of 67% on large screens.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* carousel ratio="16x9" class="col-sm-12 col-lg-8 mx-auto" */>}}
|
||||||
|
{{</* img src="img/coffee.jpg" caption="slide 1" */>}}
|
||||||
|
{{</* img src="img/phone.jpg" caption="slide 2" */>}}
|
||||||
|
{{</* img src="img/dunes.jpg" caption="slide 3" */>}}
|
||||||
|
{{</* /carousel */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Collapse
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a button that, when clicked, triggers a panel to appear or disappear.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* button collapse="collapse-1" */>}}
|
||||||
|
Trigger panel
|
||||||
|
{{</* /button */>}}
|
||||||
|
|
||||||
|
{{</* collapse id="collapse-1" class="p-3 border rounded" */>}}
|
||||||
|
Some placeholder content for the collapse component. This panel is <i>hidden by default</i> but
|
||||||
|
revealed when the user activates the relevant trigger.
|
||||||
|
{{</* /collapse */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Command prompt
|
||||||
|
|
||||||
|
Use the `command` shortcode to generate a block with a default bash command prompt.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* command */>}}
|
||||||
|
export MY_VAR=123
|
||||||
|
{{</* /command */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
Specify `user` and `host` to add the user context to the prompt. In addition, use `(out)` to specify an output line and use `\` to denote a line continuation.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* command user="user" host="localhost" */>}}
|
||||||
|
export MY_VAR=123
|
||||||
|
echo "hello"
|
||||||
|
(out)hello
|
||||||
|
echo one \
|
||||||
|
two \
|
||||||
|
three
|
||||||
|
(out)one two three
|
||||||
|
echo "goodbye"
|
||||||
|
(out)goodbye
|
||||||
|
{{</* /command */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
|
||||||
|
Use the `docs` shortcode to display the content of a `js`, `scss` or `toml` file:
|
||||||
|
|
||||||
|
{{< docs name="theme-colors" file="config/_default/params.toml" >}}
|
||||||
|
|
||||||
|
## Icon
|
||||||
|
|
||||||
|
As an example, the following shortcodes show a square check, a brand logo, and a circle check.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* fa square-check */>}}
|
||||||
|
{{</* fab linkedin */>}}
|
||||||
|
{{</* fas circle-check */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Image
|
||||||
|
|
||||||
|
As an example, the following shortcode displays an image with rounded corners and a 21x9 aspect ratio.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* image src="img/flowers.jpg" ratio="21x9" caption="Figure caption" class="rounded" */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Nav
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a tab group with vertically aligned pills.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* nav type="pills" vertical="true" */>}}
|
||||||
|
{{</* nav-item header="Nav Item #1" show="true" */>}}
|
||||||
|
This is the first item's nav body. It supports HTML content. The item is shown by adding the value
|
||||||
|
<code>show</code> to the <code>class</code> argument.
|
||||||
|
{{</* /nav-item */>}}
|
||||||
|
{{</* nav-item header="Nav Item #2" */>}}
|
||||||
|
This is the second item's nav body. It too supports HTML content.
|
||||||
|
{{</* /nav-item */>}}
|
||||||
|
{{</* nav-item header="Nav Item #3" */>}}
|
||||||
|
This is the third item's nav body.
|
||||||
|
{{</* /nav-item */>}}
|
||||||
|
{{</* /nav */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Navbar
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a light navigation header.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* navbar path="about" color="primary" size="md" search="false" menus="sample" title="Brand" mode="false" */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Spinner
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a centered spinner.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* spinner color="info" class="text-center" */>}}
|
||||||
|
Loading...
|
||||||
|
{{</* /spinner */>}}
|
||||||
|
{{< /example>}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Toast
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a button that, when clicked, triggers the toast message.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* button id="toastButton" */>}}
|
||||||
|
Show toast
|
||||||
|
{{</* /button */>}}
|
||||||
|
|
||||||
|
{{</* toast header="Custom title" */>}}
|
||||||
|
This is a toast message.
|
||||||
|
{{</* /toast */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
||||||
|
|
||||||
|
## Tooltip
|
||||||
|
|
||||||
|
As an example, the following shortcode displays a tooltip for a colored hyperlink.
|
||||||
|
|
||||||
|
<!-- markdownlint-disable MD037 -->
|
||||||
|
{{< example lang="hugo" >}}
|
||||||
|
{{</* tooltip color="primary" title="Tooltip" href="#!" */>}}
|
||||||
|
Tooltip demonstration
|
||||||
|
{{</* /tooltip */>}}
|
||||||
|
{{< /example >}}
|
||||||
|
<!-- markdownlint-enable MD037 -->
|
@@ -1,58 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Mark Dumay"
|
|
||||||
title: "Code Highlighting"
|
|
||||||
date: 2022-04-16
|
|
||||||
description: "Examples on how to enable code highlighting."
|
|
||||||
tags: ["code"]
|
|
||||||
thumbnail: img/notepad.jpg
|
|
||||||
photoCredits: <a href="https://unsplash.com/@frederickjmedina">Frederick Medina</a>
|
|
||||||
photoSource: <a href="https://unsplash.com/photos/PdfRE-xB--s">Unsplash</a>
|
|
||||||
---
|
|
||||||
|
|
||||||
## Code Fencing
|
|
||||||
|
|
||||||
Use code fencing to highlight the syntax of a specific language.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"themes": [],
|
|
||||||
"projects": [],
|
|
||||||
"configuration": {}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
```html
|
|
||||||
<div class="highlight">
|
|
||||||
<pre>
|
|
||||||
<code>some code...</code>
|
|
||||||
</pre>
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Highlight Shortcode
|
|
||||||
|
|
||||||
Use the `highlight` shortcode to customize the layout of a specific code block.
|
|
||||||
|
|
||||||
{{< highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" >}}
|
|
||||||
// GetTitleFunc returns a func that can be used to transform a string to
|
|
||||||
// title case.
|
|
||||||
//
|
|
||||||
// The supported styles are
|
|
||||||
//
|
|
||||||
// - "Go" (strings.Title)
|
|
||||||
// - "AP" (see https://www.apstylebook.com/)
|
|
||||||
// - "Chicago" (see https://www.chicagomanualofstyle.org/home.html)
|
|
||||||
//
|
|
||||||
// If an unknown or empty style is provided, AP style is what you get.
|
|
||||||
func GetTitleFunc(style string) func(s string) string {
|
|
||||||
switch strings.ToLower(style) {
|
|
||||||
case "go":
|
|
||||||
return strings.Title
|
|
||||||
case "chicago":
|
|
||||||
return transform.NewTitleConverter(transform.ChicagoStyle)
|
|
||||||
default:
|
|
||||||
return transform.NewTitleConverter(transform.APStyle)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
{{< / highlight >}}
|
|
@@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Hugo Authors"
|
|
||||||
title: "Emoji Support"
|
|
||||||
date: 2021-07-15
|
|
||||||
description: "Guide to emoji usage in Hugo."
|
|
||||||
tags: ["emoji"]
|
|
||||||
# thumbnail: img/dunes.jpg
|
|
||||||
thumbnail: https://picsum.photos/id/184/4288/2848.jpg
|
|
||||||
photoCredits: <a href="https://unsplash.com/@timdegroot">Tim de Groot</a>
|
|
||||||
photoSource: <a href="https://unsplash.com/photos/yNGQ830uFB4">Unsplash</a>
|
|
||||||
---
|
|
||||||
|
|
||||||
Emoji can be enabled in a Hugo project in a number of ways.
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes).
|
|
||||||
|
|
||||||
To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g.
|
|
||||||
|
|
||||||
<p><span class="nowrap"><span class="emojify">🙈</span> <code>:see_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙉</span> <code>:hear_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙊</span> <code>:speak_no_evil:</code></span></p>
|
|
||||||
<br>
|
|
||||||
|
|
||||||
The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference for emoji shorthand codes.
|
|
14
content/en/blog/first-post.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
author: Mark Dumay
|
||||||
|
title: First post
|
||||||
|
date: 2022-10-01
|
||||||
|
description: This is my first blog post.
|
||||||
|
tags: ["blog"]
|
||||||
|
thumbnail: img/notepad.jpg
|
||||||
|
photoCredits: <a href="https://unsplash.com/@frederickjmedina">Frederick Medina</a>
|
||||||
|
photoSource: <a href="https://unsplash.com/photos/PdfRE-xB--s">Unsplash</a>
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque vulputate, ante in luctus congue, leo risus semper justo, vel consequat sapien lectus quis ipsum. In imperdiet urna justo. Nulla vel pellentesque ipsum. Cras congue feugiat dolor ac aliquam. Pellentesque eget dui venenatis, ultrices urna ac, vehicula nibh. Curabitur est lectus, dapibus eu vehicula non, malesuada et dui. Nam enim nulla, egestas et nunc non, elementum aliquet justo. Mauris euismod mauris sapien, eget vestibulum odio dictum sit amet. Morbi nisl elit, placerat at auctor in, finibus ac neque. Curabitur placerat feugiat risus non vestibulum. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque quis cursus est, nec posuere libero.
|
||||||
|
|
||||||
|
In ac lobortis diam. Curabitur id dui ac nunc mattis rhoncus a sed lorem. Sed lobortis sem turpis, at posuere enim dignissim et. Vivamus fermentum justo quis volutpat volutpat. Proin eget vehicula neque, ut tempus urna. Duis ac ex vel leo pharetra lobortis et vitae lacus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Aliquam erat volutpat. Suspendisse ullamcorper ultrices elementum. Suspendisse mi elit, commodo at varius a, cursus a ligula. Sed et mattis elit, eu luctus arcu. Cras a porttitor libero. Vestibulum tincidunt sed magna at dapibus. Sed quis orci eu lacus aliquam tristique. Integer porttitor ultrices ipsum quis porttitor. Etiam a sodales ligula.
|
16
content/en/blog/fourth-post.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
author: Mark Dumay
|
||||||
|
title: Fourth post
|
||||||
|
date: 2023-01-01
|
||||||
|
description: This is my fourth blog post.
|
||||||
|
tags: ["blog"]
|
||||||
|
thumbnail: img/flowers.jpg # https://picsum.photos/id/106/2592/1728
|
||||||
|
photoCredits: <a href="https://unsplash.com/@flutterhappy">Arvee Marie</a>
|
||||||
|
photoSource: <a href="https://unsplash.com/photos/YnfGtpt2gf4">Unsplash</a>
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam finibus libero in felis accumsan, vitae imperdiet metus vehicula. Quisque nec dignissim purus. In id dui porta sapien posuere viverra nec vel nisi. Sed varius tincidunt lectus, quis sagittis felis interdum id. Proin purus odio, ultrices auctor libero convallis, volutpat gravida turpis. Ut commodo metus orci, quis sagittis lectus rhoncus non. Nulla et lectus tortor. Suspendisse quam felis, molestie non odio quis, consequat venenatis orci. Etiam sed turpis sit amet elit scelerisque imperdiet. Sed suscipit felis non nibh suscipit egestas. Nulla sodales libero non rhoncus consequat. Nunc in elit at est cursus congue ut ac velit. Cras luctus libero augue, id semper sapien volutpat ultrices.
|
||||||
|
|
||||||
|
Pellentesque sit amet sollicitudin nibh. Cras in dolor eget quam feugiat ultricies in ac lectus. Ut venenatis vitae justo quis pretium. Pellentesque vulputate nulla ac est iaculis vulputate. Proin pellentesque sem nec molestie imperdiet. Duis eu molestie sapien, vel ultricies lacus. Donec in felis tempus, rutrum ipsum at, fermentum felis. Praesent mi odio, semper non vulputate vitae, vulputate quis ex.
|
||||||
|
|
||||||
|
Nunc rhoncus eleifend gravida. Aliquam feugiat tristique pellentesque. Pellentesque vel elit sed nulla commodo convallis. Curabitur placerat sapien augue, ac semper metus volutpat non. Sed semper ultricies enim, consequat convallis justo placerat eget. Ut fermentum leo facilisis metus congue commodo. Vestibulum consectetur magna vitae ullamcorper sodales. Nulla lobortis aliquam odio id tincidunt. Suspendisse efficitur auctor tortor non consequat. Quisque sit amet posuere lorem, convallis bibendum nisi. Proin ullamcorper justo tempus dignissim scelerisque. Quisque sit amet sapien libero. Phasellus eget enim velit. Proin ut fermentum dui. Proin gravida tortor in ligula lacinia, id dapibus dui tincidunt. Mauris suscipit nisi et urna consectetur, non venenatis nisi euismod.
|
@@ -1,165 +0,0 @@
|
|||||||
---
|
|
||||||
author: Hugo Authors
|
|
||||||
title: Markdown Syntax Guide
|
|
||||||
description: Use Markdown syntax and basic HTML elements to style your Hugo content files.
|
|
||||||
tags: ["markdown", "css", "html"]
|
|
||||||
date: 2022-01-14
|
|
||||||
thumbnail: img/phone.jpg # https://picsum.photos/id/160/3200/2119
|
|
||||||
photoCredits: <a href="https://unsplash.com/@thomweerd">Thom</a>
|
|
||||||
photoSource: <a href="https://unsplash.com/photos/Zdcq3iKly6g">Unsplash</a>
|
|
||||||
---
|
|
||||||
|
|
||||||
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
## Headings
|
|
||||||
|
|
||||||
The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable-next-line -->
|
|
||||||
# H1
|
|
||||||
|
|
||||||
## H2
|
|
||||||
|
|
||||||
### H3
|
|
||||||
|
|
||||||
#### H4
|
|
||||||
|
|
||||||
##### H5
|
|
||||||
|
|
||||||
###### H6
|
|
||||||
|
|
||||||
## Paragraph
|
|
||||||
|
|
||||||
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
|
|
||||||
|
|
||||||
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
|
|
||||||
|
|
||||||
## Blockquotes
|
|
||||||
|
|
||||||
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.
|
|
||||||
|
|
||||||
### Blockquote without attribution
|
|
||||||
|
|
||||||
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
|
|
||||||
> **Note** that you can use _Markdown syntax_ within a blockquote.
|
|
||||||
{.blockquote}
|
|
||||||
|
|
||||||
### Blockquote with attribution
|
|
||||||
|
|
||||||
> Don't communicate by sharing memory, share memory by communicating.<br>
|
|
||||||
> — <cite>Rob Pike[^1]</cite>
|
|
||||||
{.blockquote}
|
|
||||||
|
|
||||||
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
|
|
||||||
|
|
||||||
<figure>
|
|
||||||
<blockquote class="blockquote">
|
|
||||||
<p>A well-known quote, contained in a blockquote element.</p>
|
|
||||||
</blockquote>
|
|
||||||
<figcaption class="blockquote-footer">
|
|
||||||
Someone famous in <cite title="Source Title">Source Title</cite>
|
|
||||||
</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
## Tables
|
|
||||||
|
|
||||||
Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
|
|
||||||
|
|
||||||
| Name | Age |
|
|
||||||
| ----- | --- |
|
|
||||||
| Bob | 27 |
|
|
||||||
| Alice | 23 |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
### Inline Markdown within tables
|
|
||||||
|
|
||||||
| Italics | Bold | Code |
|
|
||||||
| --------- | -------- | ------ |
|
|
||||||
| _italics_ | **bold** | `code` |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Code Blocks
|
|
||||||
|
|
||||||
### Code block with backticks
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Example HTML5 Document</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<p>Test</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD046 -->
|
|
||||||
### Code block indented with four spaces
|
|
||||||
|
|
||||||
<!doctype html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Example HTML5 Document</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<p>Test</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
<!-- markdownlint-enable MD046 -->
|
|
||||||
|
|
||||||
### Code block with Hugo's internal highlight shortcode
|
|
||||||
|
|
||||||
{{< highlight html >}}
|
|
||||||
|
|
||||||
<!doctype html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<title>Example HTML5 Document</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<p>Test</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
{{< /highlight >}}
|
|
||||||
|
|
||||||
## List Types
|
|
||||||
|
|
||||||
### Ordered List
|
|
||||||
|
|
||||||
1. First item
|
|
||||||
2. Second item
|
|
||||||
3. Third item
|
|
||||||
|
|
||||||
### Unordered List
|
|
||||||
|
|
||||||
- List item
|
|
||||||
- Another item
|
|
||||||
- And another item
|
|
||||||
|
|
||||||
### Nested list
|
|
||||||
|
|
||||||
- Fruit
|
|
||||||
- Apple
|
|
||||||
- Orange
|
|
||||||
- Banana
|
|
||||||
- Dairy
|
|
||||||
- Milk
|
|
||||||
- Cheese
|
|
||||||
|
|
||||||
## Other Elements — abbr, sub, sup, kbd, mark
|
|
||||||
|
|
||||||
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
|
|
||||||
|
|
||||||
H<sub>2</sub>O
|
|
||||||
|
|
||||||
X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
|
|
||||||
|
|
||||||
Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
|
|
||||||
|
|
||||||
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.
|
|
@@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Hugo Authors"
|
|
||||||
title: "Rich Content"
|
|
||||||
date: 2021-07-13
|
|
||||||
description: "A brief description of Hugo Shortcodes."
|
|
||||||
tags: ["shortcode", "privacy"]
|
|
||||||
thumbnail: img/flowers.jpg # https://picsum.photos/id/106/2592/1728
|
|
||||||
photoCredits: <a href="https://unsplash.com/@flutterhappy">Arvee Marie</a>
|
|
||||||
photoSource: <a href="https://unsplash.com/photos/YnfGtpt2gf4">Unsplash</a>
|
|
||||||
---
|
|
||||||
|
|
||||||
Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.
|
|
||||||
|
|
||||||
## <!--more-->
|
|
||||||
|
|
||||||
## YouTube Privacy Enhanced Shortcode
|
|
||||||
|
|
||||||
{{< youtube id="ZJthWmvUzzc" class="video">}}
|
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Twitter Simple Shortcode
|
|
||||||
|
|
||||||
{{< twitter_simple user="SanDiegoZoo" id="1453110110599868418" >}}
|
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Vimeo Simple Shortcode
|
|
||||||
|
|
||||||
{{< vimeo_simple id="48912912" class="__h_video" >}}
|
|
16
content/en/blog/second-post.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
author: Mark Dumay
|
||||||
|
title: Second post
|
||||||
|
date: 2022-11-01
|
||||||
|
description: This is my second blog post.
|
||||||
|
tags: ["blog"]
|
||||||
|
thumbnail: img/phone.jpg # https://picsum.photos/id/160/3200/2119
|
||||||
|
photoCredits: <a href="https://unsplash.com/@thomweerd">Thom</a>
|
||||||
|
photoSource: <a href="https://unsplash.com/photos/Zdcq3iKly6g">Unsplash</a>
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non sollicitudin sapien. Ut porttitor lectus eu tempor ultricies. Sed semper tincidunt nibh pellentesque condimentum. Vivamus dictum sem eu rhoncus semper. Vestibulum convallis congue tincidunt. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Mauris magna urna, egestas sit amet ligula quis, viverra semper arcu. Praesent laoreet nunc vitae nulla posuere facilisis.
|
||||||
|
|
||||||
|
Nunc eget dignissim ex, sed lobortis leo. Suspendisse mollis posuere tellus, in viverra nunc ullamcorper vitae. Nam vel tempor arcu, in imperdiet odio. Fusce malesuada vehicula odio, in iaculis nulla congue eget. Quisque id odio id nisl facilisis posuere porta sit amet mauris. Curabitur lorem leo, tempus id rhoncus eget, placerat vitae lectus. Morbi eu aliquet enim. Nulla malesuada laoreet sodales.
|
||||||
|
|
||||||
|
Nunc volutpat dui in elit euismod, sed egestas purus tristique. Nam in condimentum mauris. Praesent nec suscipit enim. Aliquam dolor ipsum, faucibus vitae purus ac, congue egestas nisi. Donec hendrerit erat eu arcu porttitor rhoncus. Nunc a odio bibendum metus semper pellentesque. Sed at sapien ut est semper eleifend. Aliquam lorem libero, porttitor nec tristique ut, auctor vitae ipsum. Suspendisse pretium pharetra rutrum. Nulla tincidunt tempus enim eu sagittis. Maecenas pulvinar metus a urna mattis dictum sed id tellus.
|
16
content/en/blog/third-post.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
author: Mark Dumay
|
||||||
|
title: Third post
|
||||||
|
date: 2022-12-01
|
||||||
|
description: This is my third blog post.
|
||||||
|
tags: ["blog"]
|
||||||
|
thumbnail: https://picsum.photos/id/184/4288/2848.jpg
|
||||||
|
photoCredits: <a href="https://unsplash.com/@timdegroot">Tim de Groot</a>
|
||||||
|
photoSource: <a href="https://unsplash.com/photos/yNGQ830uFB4">Unsplash</a>
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent id scelerisque ligula. Vestibulum eu lorem tortor. Suspendisse tristique ultrices mauris, non maximus lorem faucibus in. Suspendisse sagittis eleifend dapibus. Curabitur dignissim luctus sapien eu consequat. Proin congue dui vel ipsum bibendum varius. Pellentesque cursus nisi metus, egestas eleifend ipsum sollicitudin vitae. Sed vitae erat elementum, semper turpis sed, molestie nulla.
|
||||||
|
|
||||||
|
Nulla molestie ultrices vehicula. Etiam iaculis, erat a blandit blandit, nulla tellus dapibus ligula, vitae venenatis turpis diam non felis. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed vitae arcu in justo iaculis egestas. In imperdiet arcu vitae pharetra commodo. Quisque ut erat eget nisl semper laoreet vitae eget ligula. Mauris bibendum purus nec vulputate faucibus. In luctus sagittis ante, quis laoreet orci bibendum vitae. Nam at odio accumsan, tincidunt eros at, lacinia metus. In et ultricies sapien, a mollis est. Nunc convallis orci eu tristique euismod. Proin vel ullamcorper diam. Quisque et semper orci. Proin pharetra lorem justo, id malesuada erat feugiat sit amet. Praesent bibendum mi at lorem volutpat suscipit. Morbi sed libero elit.
|
||||||
|
|
||||||
|
Nunc sodales est eu ipsum volutpat, in mollis dui facilisis. Nulla faucibus interdum lectus, a condimentum elit vulputate eu. Nunc ipsum risus, suscipit sit amet nulla ac, pulvinar maximus nulla. In venenatis diam erat, non elementum ante dignissim posuere. Aliquam sem justo, luctus at vestibulum ut, egestas ut quam. Quisque a dolor viverra, aliquam nunc vel, lacinia nulla. In id magna magna. Morbi dapibus pretium sollicitudin. Morbi volutpat augue at felis tristique, quis euismod tellus vulputate. Morbi dui lacus, aliquam eget quam vel, vestibulum faucibus enim. Proin porta pretium metus id venenatis. Aliquam nec tempor lorem. Vivamus euismod est varius sagittis placerat. Maecenas tincidunt elementum libero, at imperdiet elit feugiat vel.
|
@@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
title: Credits
|
|
||||||
description: Hinode is fully open source and uses several open-source frameworks and libraries.
|
|
||||||
date: "2023-01-14"
|
|
||||||
group: about
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Team
|
|
||||||
|
|
||||||
Hinode is maintained by [Mark Dumay]({{< param "links.repository_owner" >}}) and several contributors as an open-source repository on GitHub. You are more than welcome to contribute. Get involved in the development by [opening an issue]({{< param "links.issue_tracker" >}}) or submitting a pull request. Read our [contributing guidelines]({{< ref "contribute" >}}) for information on how we develop.
|
|
||||||
|
|
||||||
## Core components
|
|
||||||
|
|
||||||
Hinode is based on the following core components:
|
|
||||||
|
|
||||||
- [Hugo]({{< param "links.hugo" >}}) is a fast and modern static site generator written in Go. It is a so-called static site generator, meaning that the website is created when you update its content. This is a different approach to systems that dynamically build a page upon request.
|
|
||||||
- [Bootstrap]({{< param "links.bootstrap" >}}) is a popular, open-source web development framework. Using a mobile-first approach, it provides several functions and components to simplify the creation of responsive websites.
|
|
||||||
- [npm]({{< param "links.npm" >}}) is a software registry that enables the sharing and reuse of both open-source and private software packages. By taking advantage of its version management, software dependencies are easily tracked and updated.
|
|
||||||
|
|
||||||
## Themes
|
|
||||||
|
|
||||||
Hinode is inspired by the following themes:
|
|
||||||
|
|
||||||
- [Blist]({{< param "links.blist" >}}) is a clean and fast blog theme for your Hugo site using Tailwind CSS.
|
|
||||||
- [Doks]({{< param "links.doks" >}}) is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: License
|
|
||||||
description: Hinode's open-source license for the codebase and documentation.
|
|
||||||
date: "2023-01-14"
|
|
||||||
group: about
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Codebase
|
|
||||||
|
|
||||||
The codebase of Hinode is open source under the conditions of the [MIT license]({{< param "links.license" >}}) and is copyright © 2023 by Mark Dumay. In short, the MIT license allows you to use the Hinode codebase for both personal and commercial use, as long as you include the original license and copyright notice. Licensed works, modifications, and larger works may be distributed under different terms and without source code. No liability or warranty is given.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
The documentation of Hinode is licensed under the Creative Commons ([CC BY-NC 4.0)]({{< param "links.cc_by_nc_4_0" >}}) license. This includes all files within the repository's `/content` folder and its children, as well as the "README" in the repository root. The license allows you to share and adapt the materials, as long as you give appropriate credit and do not use the materials for commercial purposes. No warranties are given.
|
|
@@ -1,67 +0,0 @@
|
|||||||
---
|
|
||||||
title: Icons
|
|
||||||
description: Configure secure access to icons from Bootstrap and Font Awesome.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: advanced-settings
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Hinode processes the Bootstrap icons to ensure they adhere to the strict [content security policy]({{< ref "server" >}}). In addition, it provides access to the free icons of [Font Awesome]({{< param "links.fontawesome" >}}).
|
|
||||||
|
|
||||||
## Bootstrap icons
|
|
||||||
|
|
||||||
Bootstrap uses various embedded vector images (in <abbr title="Scalable Vector Graphics">SVG</abbr> format) throughout its Sass source files. Hinode replaces these embedded images with file-based vector images, as the [content security policy]({{< ref "server" >}}) prohibits loading of embedded images. To ensure the images are consistent with the [theme colors]({{< ref "colors" >}}), the images are postprocessed using [Hugo templating]({{< param "links.hugo_templates">}}).
|
|
||||||
|
|
||||||
### Build pipeline
|
|
||||||
|
|
||||||
Hinodes uses npm and mounted folders to create a flexibile virtual file system that is automatically kept up to date. Review the [overview]({{< ref "overview" >}}) for a detailed explanation. The build pipeline of the Bootstrap icons consists of four steps. It is intertwined with the [build process for the stylesheets]({{< ref "styles" >}}).
|
|
||||||
|
|
||||||
1. Override the inline Bootstrap icon definitions
|
|
||||||
|
|
||||||
Replace the default inline icon definitions within the Bootstrap Sass files with references to local vector images. Use the file `assets/scss/common/_icons.scss` to ensure the definitions take precedence over the default Bootstrap values. For example, the following statement updates the value of the `$form-switch-focus-bg-image`:
|
|
||||||
|
|
||||||
```scss
|
|
||||||
$form-switch-focus-bg-image: url("icons/form-switch-focus-bg-image.svg") !default;
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Export the Sass variables
|
|
||||||
|
|
||||||
Export the required Sass variables by defining them in the `assets/scss/common/_export.scss` file. Hinode converts the variable names from kebab case to snake case to make them compatible with Hugo's variable naming convention. For example, the css variable `--form-switch-focus-color` is exposed as `.form_switch_focus_color` to the Hugo templates.
|
|
||||||
|
|
||||||
```scss
|
|
||||||
:hinode-theme {
|
|
||||||
--form-switch-focus-color: #{$form-switch-focus-color};
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Reference the Sass variables within each icon file
|
|
||||||
|
|
||||||
Use [Hugo templating]({{< param "links.hugo_templates">}}) to reference the Sass variables for fill colors and stroke colors. For example, the file `assets/icons/form-switch-focus-bg-image.svg` defines the fill color as `{{ .form_switch_focus_color }}`. The entire vector definition is as such:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'>
|
|
||||||
<circle r='3' fill='{{ .form_switch_focus_color }}'/>
|
|
||||||
</svg>
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Process the icon files
|
|
||||||
|
|
||||||
Add the local icon files to the `assets/icons` folder with a filename as defined in step 1. The partial `partials/head/stylesheet.html` calls the partial `partials/head/icons.html` to process all icon files with the `.svg` extension recursively. The output is stored in the `icons` folder within the output directory (usually `public` when building the site). The icon files are referenced in the main stylesheet automatically.
|
|
||||||
|
|
||||||
### Icons definitions
|
|
||||||
|
|
||||||
The icons are defined in the file `assets/scss/common/_icons.scss`. The current configuration is the following:
|
|
||||||
|
|
||||||
{{< docs name="icons" file="assets/scss/common/_icons.scss" >}}
|
|
||||||
|
|
||||||
### Export definitions
|
|
||||||
|
|
||||||
The exported variables are defined in the file `assets/scss/common/_export.scss`. The current configuration is the following:
|
|
||||||
|
|
||||||
{{< docs name="export" file="assets/scss/common/_export.scss" >}}
|
|
||||||
|
|
||||||
## Font Awesome icons
|
|
||||||
|
|
||||||
[Font Awesome]({{< param "links.fontawesome" >}}) provides a collection of icons to be used freely on websites and other media. See the [icons documentation]({{< relref "../content/icons" >}}) in the content section on how to use them to style your website. Hinode uses the <abbr title="Cascading Style Sheets">CSS</abbr> files and web fonts of Font Awesome, as the [content security policy]({{< ref "server" >}}) prohibits the inline execution of stylesheets by the JavaScripts of Font Awesome. The CSS files are bundled with the main stylesheet. The web fonts are copied to the `/static/fonts` folder with the repository. Use the npm command `npm run copy:fonts` to copy the latest version of the files. The CSS files are referenced in the `assets/scss/app.scss` file. This is the current configuration:
|
|
||||||
|
|
||||||
{{< docs name="awesome" file="assets/scss/app.scss" >}}
|
|
@@ -1,66 +0,0 @@
|
|||||||
---
|
|
||||||
title: Overview
|
|
||||||
description: Configure and customize Hinode to your liking using Hugo Templating and npm dependencies.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: advanced-settings
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
As a theme for Hugo, Hinode is highly configurable and customizable. Based on Go's template libraries, Hugo enriches plain Markdown content with powerful features to generate websites. More information is available in [Hugo's documentation]({{< param "links.hugo_templates" >}}). To take advantage of package versioning and dependency management, Hinode takes a slightly different approach compared to most themes. The below paragraphs clarify the build system.
|
|
||||||
|
|
||||||
## npm packages
|
|
||||||
|
|
||||||
Both the [main theme]({{< param "links.repository" >}}) and [child theme]({{< param "links.repository_child" >}}) packages of Hinode are defined in the file `package.json` in the repository root. The extract below defines the key elements of the package configuration. The `name` is a unique identifier to identify the [package on npm]({{< param "links.package_npm" >}}). The `version` tag uses [semantic versioning]({{< param "links.semver" >}}), consisting of a `MAJOR` version, `MINOR` version, and `PATCH` version. In short, anything below `MAJOR` version `1` is considered to be in development and may not be backwards compatible. Starting from `1`, each `MAJOR` version may introduce breaking changes, whilst `MINOR` version usually introduce new features that are compatible with the `MAJOR` version. Lastly, `PATCH` usually indicates a bug fix or small revision.
|
|
||||||
|
|
||||||
The other two sections of interest are `devDependencies` and `otherDependencies`. As an Hugo theme, Hinode does not require any packages in production. Instead the development dependencies are used to generate the static site and its assets. For example, Bootstrap's JavaScript distribution file `/node_modules/bootstrap/dist/js` is bundled into the `js/main.bundle<.min>.js` file during build. The path `/node_modules/bootstrap/` refers to the Bootstap package defined as dependency. Lastly, the Hugo binary is installed as version-controlled dependency too. This ensures the build process is transparent and traceable, which simplifies debugging. Please refer to the [commands]({{< ref "commands" >}}) section to review the various npm commands available.
|
|
||||||
|
|
||||||
```yml
|
|
||||||
{
|
|
||||||
"name": "@gethinode/hinode",
|
|
||||||
"version": "0.8.0",
|
|
||||||
"scripts": {
|
|
||||||
[...]
|
|
||||||
},
|
|
||||||
[...]
|
|
||||||
"devDependencies": {
|
|
||||||
"bootstrap": "^5.2.3",
|
|
||||||
[...]
|
|
||||||
},
|
|
||||||
"otherDependencies": {
|
|
||||||
"hugo": "0.110.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Mounted folders
|
|
||||||
|
|
||||||
Hugo supports the [mounting of folders]({{< param "links.hugo_mounts" >}}) since version 0.56.0. Hinode takes advantage of this feature to create a virtual file system, combining assets from multiple sources. For example, the below section of the `/config/_default/config.toml` instructs Hugo to make Bootstrap's JavaScript distribution file `/node_modules/bootstrap/dist/js` available in the `/assets/js` folder. This file is then bundled with the JavaScript files defined in the `/assets/js` folder of Hinode.
|
|
||||||
|
|
||||||
{{< alert color="primary" >}}
|
|
||||||
When you add a mount, the default mount for the concerned target root is ignored: be sure to explicitly add it.
|
|
||||||
{{< /alert >}}
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[module]
|
|
||||||
[...]
|
|
||||||
[[module.mounts]]
|
|
||||||
source = "assets"
|
|
||||||
target = "assets"
|
|
||||||
[[module.mounts]]
|
|
||||||
source = "node_modules/bootstrap/dist/js"
|
|
||||||
target = "assets/js/vendor/bootstrap"
|
|
||||||
includeFiles = "*.bundle.js"
|
|
||||||
```
|
|
||||||
|
|
||||||
As another example, the Hinode child theme merges the key folders of the main theme with its own folder. This simplifies the modification of any base files, as the files in the local repository take precedence over the files of the main theme.
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[module]
|
|
||||||
[...]
|
|
||||||
[[module.mounts]]
|
|
||||||
source = "node_modules/@gethinode/hinode/i18n"
|
|
||||||
target = "i18n"
|
|
||||||
[[module.mounts]]
|
|
||||||
source = "i18n"
|
|
||||||
target = "i18n"
|
|
||||||
```
|
|
@@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
title: Scripts
|
|
||||||
description: Automatically bundle local and external JavaScript files into a single file.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: advanced-settings
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Hinode bundles local and external JavaScript into a single file. By utilizing [npm]({{< ref "overview" >}}), external JavaScript files are automatically ingested and kept up to date.
|
|
||||||
|
|
||||||
## Build pipeline
|
|
||||||
|
|
||||||
Hinodes uses npm and mounted folders to create a flexibile virtual file system that is automatically kept up to date. Review the [overview]({{< ref "overview" >}}) for a detailed explanation. The build pipeline of the JavaScript files consists of four steps.
|
|
||||||
|
|
||||||
1. Add the local JavaScript files
|
|
||||||
|
|
||||||
Add the local JavaScript files to the `assets/js` folder with a recognizable filename.
|
|
||||||
|
|
||||||
2. Mount the JavaScript files maintained within a node package
|
|
||||||
|
|
||||||
Make JavaScripts defined in node packages available by mounting them into the `assets/js/vendor` folder. Define the mount points in `config/_default/config.toml`.
|
|
||||||
|
|
||||||
3. Bundle the JavaScript files
|
|
||||||
|
|
||||||
The partial `partials/footer/scripts.html` bundles all files that end with `.js` recursively into a single file called `js/main.bundle.js`. In production mode, the output is minified and linked to with a [fingerprint]({{< param "links.hugo_fingerprint" >}}).
|
|
||||||
|
|
||||||
4. Link to the JavaScript in the base layout
|
|
||||||
|
|
||||||
Hinode's base layout `layouts/_default/baseof.html` imports the bundled JavaScript file in the footer. The file is cached to improve performance.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
Mount the external JavaScript files to Hugo's virtual file system within the file `config/_default/config.toml`. The current configuration imports the relevant files of [Bootstrap]({{< param "links.bootstrap" >}}) and [FlexSearch]({{< param "links.flexsearch" >}}).
|
|
||||||
|
|
||||||
{{< docs name="javascript" file="config/_default/config.toml" >}}
|
|
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: Server
|
|
||||||
description: Configure the server headers to refine the content security policy.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: advanced-settings
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- TODO: expand -->
|
|
||||||
|
|
||||||
## Server headers
|
|
||||||
|
|
||||||
Hinode uses rather strict security policies by default. This ensures the site is [secure by default]({{< param "links.observatory" >}}). However, if you want to include external resources, such as images and videos, you will need to explicity add these sources to the server headers. If omitted, the browser will refuse to load these resources, resulting in broken links or missing elements. The settings of the local development server are defined in `server.toml`. See the below configuration, which captures the external resources currently used by Hinode. Refine these settings as needed. Similar settings are defined in the `netlify.toml` file provided in the repository's root when deploying to [Netlify]({{< param "links.netlify" >}}).
|
|
||||||
|
|
||||||
{{< docs name="server-config" file="config/_default/server.toml" >}}
|
|
@@ -1,59 +0,0 @@
|
|||||||
---
|
|
||||||
title: Styles
|
|
||||||
description: Use extensible Sass files to generate the stylesheets for your website.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: advanced-settings
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- TODO: include dartsass -->
|
|
||||||
|
|
||||||
Hinode uses Sass files to take advantage of variables, maps, and functions to generate the cascading style sheets of the website. By utilizing [npm]({{< ref "overview" >}}), Bootstrap's source Sass file are automatically ingested and kept up to date.
|
|
||||||
|
|
||||||
## Build pipeline
|
|
||||||
|
|
||||||
Hinodes uses npm and mounted folders to create a flexibile virtual file system that is automatically kept up to date. Review the [overview]({{< ref "overview" >}}) for a detailed explanation. The build pipeline of the stylesheet consists of five steps.
|
|
||||||
|
|
||||||
1. Define the Sass entrypoint
|
|
||||||
|
|
||||||
The main entrypoint for the Sass files is defined in `assets/scss/app.scss`. It supports Hugo templating. For example, it defines a variable `$themeFont` that links to the [font configuration]({{< ref "fonts" >}}). The variable is available within all source Sass files.
|
|
||||||
|
|
||||||
2. Import the source Sass files
|
|
||||||
|
|
||||||
The application entrypoint imports the various source Sass files defined in `assets/scss`, which are combined with the Sass files of [Bootstrap]({{< param "links.bootstrap" >}}) and [Font Awesome (Free)]({{< param "links.fontawesome" >}}). The vendor paths are relative to the `node_modules` folder, which are installed by [npm]({{< ref "commands" >}}).
|
|
||||||
|
|
||||||
3. Override and expand the Sass configuration
|
|
||||||
|
|
||||||
The import order of the source files defines which variables and functions to use. In Sass, the first definition of a variable or function takes precedence. For example, to override the setting for the variable `$primary`, is needs to be defined prior to Bootstrap's definition in `_variables.scss`.
|
|
||||||
|
|
||||||
4. Transpile the Sass files
|
|
||||||
|
|
||||||
The partial `partials/head/stylesheet.html` reads the application entrypoint, configures the `node_modules` folder as import path, and transpiles the stylesheet into a single file `main.css`. In production mode, the output is minified and linked to with a [fingerprint]({{< param "links.hugo_fingerprint" >}}).
|
|
||||||
|
|
||||||
5. Link to the stylesheet in the base layout
|
|
||||||
|
|
||||||
Hinode's base layout `layouts/_default/baseof.html` imports the generated stylesheet in the header section of the webpage via the partial `layouts/partials/head/head.html`.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
The below Sass file defines a skeleton configuration for the main entrypoint. The full configuration is defined in `assets/scss/app.scss`.
|
|
||||||
|
|
||||||
```scss
|
|
||||||
// 1) Define template variables (linking to Hugo config)
|
|
||||||
$primary: {{ site.Params.style.primary | default "#007bff" }};
|
|
||||||
|
|
||||||
// 2) Include default variable overrides
|
|
||||||
@import "common/variables.scss";
|
|
||||||
|
|
||||||
// 3) Import Bootstrap configuration
|
|
||||||
@import "bootstrap/scss/variables";
|
|
||||||
|
|
||||||
// 4) Import Bootstrap layout & components
|
|
||||||
@import "bootstrap/scss/root";
|
|
||||||
|
|
||||||
// 5) Import Font Awesome
|
|
||||||
@import "@fortawesome/fontawesome-free/scss/fontawesome";
|
|
||||||
|
|
||||||
// 6) Import Hinode theme styles
|
|
||||||
@import "common/styles.scss";
|
|
||||||
```
|
|
@@ -1,338 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Mark Dumay"
|
|
||||||
title: "Bootstrap Components"
|
|
||||||
date: 2022-12-26
|
|
||||||
draft: true
|
|
||||||
description: "Overview of available Bootstrap components."
|
|
||||||
tags: ["bootstrap"]
|
|
||||||
thumbnail: img/boots.jpg
|
|
||||||
photoCredits: <a href="https://unsplash.com/@nate_dumlao">Nathan Dumlao</a>
|
|
||||||
photoSource: <a href="https://unsplash.com/photos/QLPWQvHvmII">Unsplash</a>
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## Close button
|
|
||||||
|
|
||||||
Use HTML code to display a generic close button. See the Bootstrap [documentation][bs_close_button] for more options. The following example displays a button with default styling.
|
|
||||||
|
|
||||||
```html
|
|
||||||
<button type="button" class="btn-close" aria-label="Close"></button>
|
|
||||||
```
|
|
||||||
|
|
||||||
The result looks like this.
|
|
||||||
|
|
||||||
<button type="button" class="btn-close" aria-label="Close"></button>
|
|
||||||
|
|
||||||
## Dropdowns
|
|
||||||
|
|
||||||
### Single button
|
|
||||||
|
|
||||||
<div class="dropdown">
|
|
||||||
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
|
|
||||||
Dropdown button
|
|
||||||
</button>
|
|
||||||
<ul class="dropdown-menu">
|
|
||||||
<li><a class="dropdown-item" href="#">Action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Another action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Something else here</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Split button
|
|
||||||
|
|
||||||
<!-- Example split danger button -->
|
|
||||||
<div class="btn-group">
|
|
||||||
<button type="button" class="btn btn-danger">Action</button>
|
|
||||||
<button type="button" class="btn btn-danger dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
|
|
||||||
<span class="visually-hidden">Toggle Dropdown</span>
|
|
||||||
</button>
|
|
||||||
<ul class="dropdown-menu">
|
|
||||||
<li><a class="dropdown-item" href="#">Action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Another action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Something else here</a></li>
|
|
||||||
<li><hr class="dropdown-divider"></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Separated link</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## List group
|
|
||||||
|
|
||||||
<div class="list-group">
|
|
||||||
<a href="#" class="list-group-item list-group-item-action active" aria-current="true">
|
|
||||||
The current link item
|
|
||||||
</a>
|
|
||||||
<a href="#" class="list-group-item list-group-item-action">A second link item</a>
|
|
||||||
<a href="#" class="list-group-item list-group-item-action">A third link item</a>
|
|
||||||
<a href="#" class="list-group-item list-group-item-action">A fourth link item</a>
|
|
||||||
<a class="list-group-item list-group-item-action disabled">A disabled link item</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Modal
|
|
||||||
|
|
||||||
<!-- Button trigger modal -->
|
|
||||||
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal">
|
|
||||||
Launch demo modal
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<!-- Modal -->
|
|
||||||
<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
|
|
||||||
<div class="modal-dialog">
|
|
||||||
<div class="modal-content">
|
|
||||||
<div class="modal-header">
|
|
||||||
<h1 class="modal-title fs-5" id="exampleModalLabel">Modal title</h1>
|
|
||||||
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
|
||||||
</div>
|
|
||||||
<div class="modal-body">
|
|
||||||
...
|
|
||||||
</div>
|
|
||||||
<div class="modal-footer">
|
|
||||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
|
|
||||||
<button type="button" class="btn btn-primary">Save changes</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Navs & tabs
|
|
||||||
|
|
||||||
<ul class="nav nav-tabs">
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link active" aria-current="page" href="#">Active</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="#">Link</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="#">Link</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link disabled">Disabled</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
## Offcanvas
|
|
||||||
|
|
||||||
<a class="btn btn-primary" data-bs-toggle="offcanvas" href="#offcanvasExample" role="button" aria-controls="offcanvasExample">
|
|
||||||
Link with href
|
|
||||||
</a>
|
|
||||||
<button class="btn btn-primary" type="button" data-bs-toggle="offcanvas" data-bs-target="#offcanvasExample" aria-controls="offcanvasExample">
|
|
||||||
Button with data-bs-target
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div class="offcanvas offcanvas-start" tabindex="-1" id="offcanvasExample" aria-labelledby="offcanvasExampleLabel">
|
|
||||||
<div class="offcanvas-header">
|
|
||||||
<h5 class="offcanvas-title" id="offcanvasExampleLabel">Offcanvas</h5>
|
|
||||||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" aria-label="Close"></button>
|
|
||||||
</div>
|
|
||||||
<div class="offcanvas-body">
|
|
||||||
<div>
|
|
||||||
Some text as placeholder. In real life you can have the elements you have chosen. Like, text, images, lists, etc.
|
|
||||||
</div>
|
|
||||||
<div class="dropdown mt-3">
|
|
||||||
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown">
|
|
||||||
Dropdown button
|
|
||||||
</button>
|
|
||||||
<ul class="dropdown-menu">
|
|
||||||
<li><a class="dropdown-item" href="#">Action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Another action</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#">Something else here</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Pagination
|
|
||||||
|
|
||||||
<nav aria-label="Page navigation example">
|
|
||||||
<ul class="pagination justify-content-center">
|
|
||||||
<li class="page-item disabled">
|
|
||||||
<a class="page-link">Previous</a>
|
|
||||||
</li>
|
|
||||||
<li class="page-item"><a class="page-link" href="#">1</a></li>
|
|
||||||
<li class="page-item"><a class="page-link" href="#">2</a></li>
|
|
||||||
<li class="page-item"><a class="page-link" href="#">3</a></li>
|
|
||||||
<li class="page-item">
|
|
||||||
<a class="page-link" href="#">Next</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
## Placeholders
|
|
||||||
|
|
||||||
<div class="card w-50" aria-hidden="true">
|
|
||||||
<img src="/img/bd_placeholder_img.svg" class="card-img-top" alt="...">
|
|
||||||
<div class="card-body">
|
|
||||||
<h5 class="card-title placeholder-glow">
|
|
||||||
<span class="placeholder col-6"></span>
|
|
||||||
</h5>
|
|
||||||
<p class="card-text placeholder-glow">
|
|
||||||
<span class="placeholder col-7"></span>
|
|
||||||
<span class="placeholder col-4"></span>
|
|
||||||
<span class="placeholder col-4"></span>
|
|
||||||
<span class="placeholder col-6"></span>
|
|
||||||
<span class="placeholder col-8"></span>
|
|
||||||
</p>
|
|
||||||
<a href="#" tabindex="-1" class="btn btn-primary disabled placeholder col-6"></a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Popovers
|
|
||||||
|
|
||||||
<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
|
|
||||||
|
|
||||||
## Progress
|
|
||||||
|
|
||||||
<div class="progress">
|
|
||||||
<div class="progress-bar progress-bar-striped progress-bar-animated w-75" role="progressbar" aria-label="Animated striped example" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100"></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Scrollspy
|
|
||||||
|
|
||||||
### Navbar
|
|
||||||
|
|
||||||
<nav id="navbar-example2" class="navbar bg-light px-3 mb-3">
|
|
||||||
<a class="navbar-brand" href="#">Navbar</a>
|
|
||||||
<ul class="nav nav-pills">
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="#scrollspyHeading1">First</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="#scrollspyHeading2">Second</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item dropdown">
|
|
||||||
<a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-expanded="false">Dropdown</a>
|
|
||||||
<ul class="dropdown-menu">
|
|
||||||
<li><a class="dropdown-item" href="#scrollspyHeading3">Third</a></li>
|
|
||||||
<li><a class="dropdown-item" href="#scrollspyHeading4">Fourth</a></li>
|
|
||||||
<li><hr class="dropdown-divider"></li>
|
|
||||||
<li><a class="dropdown-item" href="#scrollspyHeading5">Fifth</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<div data-bs-spy="scroll" data-bs-target="#navbar-example2" data-bs-root-margin="0px 0px -40%" data-bs-smooth-scroll="true" class="scrollspy-example bg-light p-3 rounded-2" tabindex="0">
|
|
||||||
<h4 id="scrollspyHeading1">First heading</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="scrollspyHeading2">Second heading</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="scrollspyHeading3">Third heading</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="scrollspyHeading4">Fourth heading</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="scrollspyHeading5">Fifth heading</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Nested nav
|
|
||||||
|
|
||||||
<div class="row">
|
|
||||||
<div class="col-4">
|
|
||||||
<nav id="navbar-example3" class="h-100 flex-column align-items-stretch pe-4 border-end">
|
|
||||||
<nav class="nav nav-pills flex-column">
|
|
||||||
<a class="nav-link" href="#item-1">Item 1</a>
|
|
||||||
<nav class="nav nav-pills flex-column">
|
|
||||||
<a class="nav-link ms-3 my-1" href="#item-1-1">Item 1-1</a>
|
|
||||||
<a class="nav-link ms-3 my-1" href="#item-1-2">Item 1-2</a>
|
|
||||||
</nav>
|
|
||||||
<a class="nav-link" href="#item-2">Item 2</a>
|
|
||||||
<a class="nav-link" href="#item-3">Item 3</a>
|
|
||||||
<nav class="nav nav-pills flex-column">
|
|
||||||
<a class="nav-link ms-3 my-1" href="#item-3-1">Item 3-1</a>
|
|
||||||
<a class="nav-link ms-3 my-1" href="#item-3-2">Item 3-2</a>
|
|
||||||
</nav>
|
|
||||||
</nav>
|
|
||||||
</nav>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="col-8">
|
|
||||||
<div data-bs-spy="scroll" data-bs-target="#navbar-example3" data-bs-smooth-scroll="true" class="scrollspy-example-2" tabindex="0">
|
|
||||||
<div id="item-1">
|
|
||||||
<h4>Item 1</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-1-1">
|
|
||||||
<h5>Item 1-1</h5>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-1-2">
|
|
||||||
<h5>Item 1-2</h5>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-2">
|
|
||||||
<h4>Item 2</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-3">
|
|
||||||
<h4>Item 3</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-3-1">
|
|
||||||
<h5>Item 3-1</h5>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
<div id="item-3-2">
|
|
||||||
<h5>Item 3-2</h5>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### List group
|
|
||||||
|
|
||||||
<div class="row">
|
|
||||||
<div class="col-4">
|
|
||||||
<div id="list-example" class="list-group">
|
|
||||||
<a class="list-group-item list-group-item-action" href="#list-item-1">Item 1</a>
|
|
||||||
<a class="list-group-item list-group-item-action" href="#list-item-2">Item 2</a>
|
|
||||||
<a class="list-group-item list-group-item-action" href="#list-item-3">Item 3</a>
|
|
||||||
<a class="list-group-item list-group-item-action" href="#list-item-4">Item 4</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-8">
|
|
||||||
<div data-bs-spy="scroll" data-bs-target="#list-example" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
|
|
||||||
<h4 id="list-item-1">Item 1</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="list-item-2">Item 2</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="list-item-3">Item 3</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="list-item-4">Item 4</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Simple anchors
|
|
||||||
|
|
||||||
<!-- TODO: fix Simple anchors -->
|
|
||||||
|
|
||||||
<div class="row">
|
|
||||||
<div class="col-4">
|
|
||||||
<div id="simple-list-example" class="d-flex flex-column gap-2 simple-list-example-scrollspy text-center">
|
|
||||||
<a class="p-1 rounded" href="#simple-list-item-1">Item 1</a>
|
|
||||||
<a class="p-1 rounded" href="#simple-list-item-2">Item 2</a>
|
|
||||||
<a class="p-1 rounded" href="#simple-list-item-3">Item 3</a>
|
|
||||||
<a class="p-1 rounded" href="#simple-list-item-4">Item 4</a>
|
|
||||||
<a class="p-1 rounded" href="#simple-list-item-5">Item 5</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-8">
|
|
||||||
<div data-bs-spy="scroll" data-bs-target="#simple-list-example" data-bs-offset="0" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
|
|
||||||
<h4 id="simple-list-item-1">Item 1</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="simple-list-item-2">Item 2</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="simple-list-item-3">Item 3</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="simple-list-item-4">Item 4</h4>
|
|
||||||
<p>...</p>
|
|
||||||
<h4 id="simple-list-item-5">Item 5</h4>
|
|
||||||
<p>...</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- MARKDOWN PUBLIC LINKS -->
|
|
||||||
[bs_close_button]: https://getbootstrap.com/docs/5.2/components/close-button/
|
|
@@ -1,51 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Accordion
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the accordion shortcode to show a group of vertically collapsing and expanding items.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `accordion` shortcode to show a group of vertically collapsing and expanding items. Add `accordion-item` inner elements for each accordion item.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| class | No | Optional class attribute of the accordion element, e.g. “w-50”. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
Add an inner `accordion-item` element for each item of the accordion. The `accordion-item` element supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| header | Yes | Required header of the accordion element. |
|
|
||||||
| class | No | Optional class attribute of the inner accordion element. |
|
|
||||||
| show | No | Optional flag to indicate an item should be shown as collapsed. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays an accordion with three elements, of which the first element is expanded.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* accordion */>}}
|
|
||||||
{{</* accordion-item header="Accordion Item #1" show="true" */>}}
|
|
||||||
This is the first item's accordion body. It supports HTML content. The item is shown by adding the value
|
|
||||||
<code>show</code> to the <code>class</code> argument.
|
|
||||||
{{</* /accordion-item */>}}
|
|
||||||
{{</* accordion-item header="Accordion Item #2" */>}}
|
|
||||||
This is the second item's accordion body. It too supports HTML content.
|
|
||||||
{{</* /accordion-item */>}}
|
|
||||||
{{</* accordion-item header="Accordion Item #3" */>}}
|
|
||||||
This is the third item's accordion body.
|
|
||||||
{{</* /accordion-item */>}}
|
|
||||||
{{</* /accordion */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,34 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Alert
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the alert shortcode to display a contextual feedback message.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `alert` shortcode to display a contextual feedback message. The inner content is used as alert text.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| color | No | Optional theme color of the alert, either "primary" (default), "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". |
|
|
||||||
| dismissible | No | Optional flag to indicate the alert is dismissible, defaults to false. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a simple alert.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* alert color="danger" */>}}
|
|
||||||
A simple danger alert—check it out!
|
|
||||||
{{</* /alert */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,29 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Badge
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the badge to enrich headings and buttons.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Badges can be added to headings and buttons. The badge for a button is part of a [custom shortcode]({{< ref "button" >}} "custom shortcode"). The example below illustrates the HTML code for a heading.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode requires no arguments.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
Use HTML code to display a badge for a heading. See the Bootstrap [documentation]({{< param "links.bs_badge_heading" >}}) for more options. The following example displays a badge for a heading of size four.
|
|
||||||
|
|
||||||
{{< example >}}
|
|
||||||
<h1>Example heading of size one <span class="badge bg-secondary">New</span></h1>
|
|
||||||
<h2>Example heading of size two <span class="badge bg-secondary">New</span></h2>
|
|
||||||
<h3>Example heading of size three <span class="badge bg-secondary">New</span></h3>
|
|
||||||
<h4>Example heading of size four <span class="badge bg-secondary">New</span></h4>
|
|
||||||
<h5>Example heading of size five <span class="badge bg-secondary">New</span></h5>
|
|
||||||
<h6>Example heading of size six <span class="badge bg-secondary">New</span></h6>
|
|
||||||
{{< /example >}}
|
|
@@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Breadcrumb
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the breadcrumb shortcode to display the current page’s location within the site's navigational hierarchy.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `breadcrumb` shortcode to display the current page’s location within the site's navigational hierarchy.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| path | No | Optional path of the page, defaults to current page.
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a breadcrumb for the current page.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* breadcrumb path="breadcrumb" */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Button Group
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the button-group shortcode to display a group of buttons.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `button-group` shortcode to display a group of buttons. Add inner `<button>` elements for each [button]({{< ref "button" >}} "button").
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| aria-label | No | Optional assistive label for the button group. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a group of three buttons.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* button-group aria-label="Basic example" */>}}
|
|
||||||
{{</* button color="primary" href="#" */>}}Left{{</* /button */>}}
|
|
||||||
{{</* button color="primary" href="#" */>}}Middle{{</* /button */>}}
|
|
||||||
{{</* button color="primary" href="#" */>}}Right{{</* /button */>}}
|
|
||||||
{{</* /button-group */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,42 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Button
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the button shortcode to display a button with a hyperlink.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `button` shortcode to display a button with a hyperlink. The inner content is used as button title. The button supports an optional badge and tooltip.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| href | No | Optional address for the button or hyperlink. Automatically assigned when using collapse. |
|
|
||||||
| state | No | Optional state of the button, either "enabled" (default), "disabled", "active", or "inactive". |
|
|
||||||
| size | No | Optional size of the button, either "sm", "md" (default), or "lg". |
|
|
||||||
| color | No | Optional theme color of the element, either "primary" (default), "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". |
|
|
||||||
| badge | No | Optional positioned badge to display on top of the button. |
|
|
||||||
| outline | No | Optional flag indicating the button should be outlined, either "false" (default) or "true". |
|
|
||||||
| aria-label | No | Optional label for the badge. |
|
|
||||||
| tooltip | No | Optional text to display in a tooltip. Cannot be used together with collapse. Ignored for active/inactive buttons. |
|
|
||||||
| collapse | No | Optional panel to collapse. Cannot be used together with tooltip. Ignored for active/inactive buttons. |
|
|
||||||
| placement | No | How to position the tooltip: "top" (default), "bottom", "left", or "right". |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a tooltip for a dark button with a badge.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* button color="dark" tooltip="Click on the inbox to view your unread messages" href="#" badge="99+" */>}}
|
|
||||||
Inbox
|
|
||||||
{{</* /button */>}}
|
|
||||||
{{< /example>}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,37 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Card
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the card shortcode to display a card that links to a content page.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `card` shortcode to display a card that links to a content page. When using a rich layout, the card includes a thumbnail and a header.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| path | Yes | Required path of the page. |
|
|
||||||
| class | No | Optional class attribute of the card element, e.g. “w-50”. |
|
|
||||||
| color | No | Optional theme color of the card, either "primary", "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". By default, no color is specified. |
|
|
||||||
| padding | No | Optional padding of the content, either "0", "1", "2", "3", "4", "5", or "auto" (default). |
|
|
||||||
| header | No | Optional header components of the card, displayed in small caps. Supported values are "full" (default), "publication", "tags", and "none". |
|
|
||||||
| footer | No | Optional footer components of the card, displayed in small caps. Supported values are "full", "publication", "tags", and "none" (default). |
|
|
||||||
| orientation | No | Optional placecement of the thumbnail, either "stacked" (default), "horizontal", or "none". |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a colored, borderless horizontal card that links to the [Rich Content]({{< ref "rich-content" >}} "Rich Content") page. It includes a custom header and footer.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* card path="rich-content" class="w-100 border-0" orientation="horizontal" color="info" header="publication" footer="tags" */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,48 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Carousel
|
|
||||||
date: 2023-01-29
|
|
||||||
description: Use the carousel shortcode to display a carousel of several images.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `carousel` shortcode to display a carousel of several images, with similar behavior as the [image]({{< ref "image" >}} "image")
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| ratio | No | Aspect ratio of the image, either "1x1", "4x3", "16x9", or "21x9". If unspecified, the original aspect ratio is preserved. |
|
|
||||||
| class | No | Optional class attribute of the `carousel` element, e.g. "w-75". |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
{{< alert >}}
|
|
||||||
The carousel uses the original aspect ratio of the provided images when no aspect ratio is provided. Ensure the included images have a similar height and width to avoid inconsistent behavior.
|
|
||||||
{{< /alert >}}
|
|
||||||
|
|
||||||
Add an inner `img` element for each slide of the carousel. The `img` element supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| src | Yes | Required url of the image, e.g. "img/boots.jpg". |
|
|
||||||
| caption | No | Optional image caption. If set, the image is darkened to improve the contrast. The caption is hidden on smaller screens. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a centered carousel with three slides, 16x9 aspect ratio, and a relative width of 67% on large screens.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* carousel ratio="16x9" class="col-sm-12 col-lg-8 mx-auto" */>}}
|
|
||||||
{{</* img src="img/coffee.jpg" caption="slide 1" */>}}
|
|
||||||
{{</* img src="img/phone.jpg" caption="slide 2" */>}}
|
|
||||||
{{</* img src="img/dunes.jpg" caption="slide 3" */>}}
|
|
||||||
{{</* /carousel */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,39 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Collapse
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the collapse shortcode to reveil or hide a panel.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `collapse` shortcode to reveil or hide a panel. The panel can contain both HTML code and plain text. Link a button to the panel by assigning it's ID to the `collapse` attribute.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| id | Yes | Required unique id of the collapse element, e.g. "collapse-1". |
|
|
||||||
| class | No | Optional class attribute of the inner panel element, e.g. “p-3”. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a button that, when clicked, triggers a panel to appear or disappear.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* button collapse="collapse-1" */>}}
|
|
||||||
Trigger panel
|
|
||||||
{{</* /button */>}}
|
|
||||||
|
|
||||||
{{</* collapse id="collapse-1" class="p-3 border rounded" */>}}
|
|
||||||
Some placeholder content for the collapse component. This panel is <i>hidden by default</i> but
|
|
||||||
revealed when the user activates the relevant trigger.
|
|
||||||
{{</* /collapse */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,104 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Command Prompt
|
|
||||||
date: 2023-01-28
|
|
||||||
description: The command shortcode generates terminal output for either Bash, PowerShell, or SQL shell languages.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
The `command` shortcode generates terminal output for either `bash`, `powershell`, or `sql` shell languages.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| user | No | Optional user to add to the prompt, e.g. "user". |
|
|
||||||
| host | No | Optional host to add to the prompt, e.g. "localhost". |
|
|
||||||
| prompt | No | Optional prompt override, e.g. "PS C:\Users\User>". |
|
|
||||||
| shell | No | Type of shell, either "bash" (default), "powershell", or "sql". |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Bash (default shell)
|
|
||||||
|
|
||||||
Use the `command` shortcode to generate a block with a default bash command prompt.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* command */>}}
|
|
||||||
export MY_VAR=123
|
|
||||||
{{</* /command */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
||||||
|
|
||||||
Specify `user` and `host` to add the user context to the prompt. In addition, use `(out)` to specify an output line and use `\` to denote a line continuation.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* command user="user" host="localhost" */>}}
|
|
||||||
export MY_VAR=123
|
|
||||||
echo "hello"
|
|
||||||
(out)hello
|
|
||||||
echo one \
|
|
||||||
two \
|
|
||||||
three
|
|
||||||
(out)one two three
|
|
||||||
echo "goodbye"
|
|
||||||
(out)goodbye
|
|
||||||
{{</* /command */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
||||||
|
|
||||||
### PowerShell
|
|
||||||
|
|
||||||
Set the `shell` argument to `powershell` to generate a PowerShell terminal. Override the `prompt` to add a directory if needed. Use the backtick `` ` `` symbol to denote a line continuation.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* command prompt="PS C:\Users\User>" shell="powershell" */>}}
|
|
||||||
Write-Host `
|
|
||||||
'Hello' `
|
|
||||||
'from' `
|
|
||||||
'PowerShell!'
|
|
||||||
(out)Hello from PowerShell!
|
|
||||||
Write-Host 'Goodbye from PowerShell!'
|
|
||||||
(out)Goodbye from PowerShell!
|
|
||||||
{{</* /command */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
||||||
|
|
||||||
### SQL
|
|
||||||
|
|
||||||
Set the `shell` argument to `sql` to generate a SQL terminal. Use the `(con)` suffix to denote a line continuation.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* command prompt="mysql>" shell="sql" */>}}
|
|
||||||
set @my_var = 'foo';
|
|
||||||
set @my_other_var = 'bar';
|
|
||||||
CREATE TABLE people ((con)
|
|
||||||
first_name VARCHAR(30) NOT NULL,(con)
|
|
||||||
last_name VARCHAR(30) NOT NULL(con)
|
|
||||||
);
|
|
||||||
(out)Query OK, 0 rows affected (0.09 sec)
|
|
||||||
insert into people(con)
|
|
||||||
values ('John', 'Doe');
|
|
||||||
(out)Query OK, 1 row affected (0.02 sec)
|
|
||||||
select *(con)
|
|
||||||
from people(con)
|
|
||||||
order by last_name;
|
|
||||||
(out)+------------+-----------+
|
|
||||||
(out)| first_name | last_name |
|
|
||||||
(out)+------------+-----------+
|
|
||||||
(out)| John | Doe |
|
|
||||||
(out)+------------+-----------+
|
|
||||||
(out)1 row in set (0.00 sec)
|
|
||||||
{{</* /command */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-ensable MD037 -->
|
|
@@ -1,28 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Icon
|
|
||||||
date: 2023-02-02
|
|
||||||
description: Use the fa shortcode to add a Font Awesome icon with ease.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `fa` shortcode to quickly add a Font Awesome icon to your content. Use `fa` for regular icons, `fab` for brand icons, and `fas` for solid icons.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports unnamed arguments only and requires at least one argument. The first argument is used as the icon name without the `fa-` prefix. Additional (unnamed) arguments are passed as `class` attributes to the inner HTML element.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcodes show a square check, a brand logo, and a circle check.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* fa square-check */>}}
|
|
||||||
{{</* fab linkedin */>}}
|
|
||||||
{{</* fas circle-check */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Image
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the image shortcode to display a responsive image with a specific aspect ratio.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `image` shortcode to display a responsive image with a specific aspect ratio. The source link can refer to either an image available in the `/assets/img` folder of your site or a public web location. The shortcode renders the image as a so-called [image set]({{< param "links.mozilla_image" >}}) to optimize the image for different screen sizes and resolutions. Behind the scenes, Hugo renders the images in `WebP` format and stores them in a local folder (`resources` or `public`). The images are processed using the quality setting specified in the `[imaging]` section of the main [config file]({{< param "links.hugo_imaging" >}}) (defaults to 75). Supported image types are `.png`, `.jpeg`, `.gif`, `.tiff`, `.bmp`, and `.webp`. A fallback image of type `.jpeg` is provided for older browsers.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| src | Yes | Required url of the image, e.g. "img/boots.jpg". |
|
|
||||||
| ratio | No | Optional aspect ratio of the image, either "1x1", "4x3", "16x9", or "21x9". If set, the image is resized and cropped to match the ratio. Else the original aspect ratio of the image is kept. |
|
|
||||||
| class | No | Optional class attribute of the inner `img` element, e.g. "rounded". |
|
|
||||||
| title | No | Optional alternate text of the image. |
|
|
||||||
| caption | No | Optional figure caption. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays an image with rounded corners and a 21x9 aspect ratio.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* image src="img/flowers.jpg" ratio="21x9" caption="Figure caption" class="rounded" */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,40 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Navbar
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the navbar shortcode to display a navigation header with a toggler.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `navbar` shortcode to display a navigation header with a toggler. The menu items are derived from the site's configuration, which defaults to the menus defined under `main`. Nested items are supported at one-level depth. The navigation bar includes a search area and a language switcher if applicable. The items in the navigation header are accentuated if the current page or any of its descendants is active.
|
|
||||||
|
|
||||||
<!-- TODO: add sidebar -->
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-----------|----------|-------------|
|
|
||||||
| path | Yes | Required path of the active page. |
|
|
||||||
| menus | No | Optional name of the menu configuration, defaults to "main". |
|
|
||||||
| size | No | Optional breakpoint of the navbar toggler, either "xs", "sm", "md" (default), "lg", or "xl". |
|
|
||||||
| style | No | Optional style of the navbar, either "light" (default) or "dark". |
|
|
||||||
| color | No | Optional background color of the navbar, either "primary", "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". The default color is none. |
|
|
||||||
| search | No | Optional flag to include a search input, defaults to the parameter "logo" set in the "navigation" section of the site's parameter configuration. |
|
|
||||||
| logo | No | Optional address of the logo image, defaults to the parameter "logo" set in the "navigation" section of the site's parameter configuration. |
|
|
||||||
| title | No | Optional brand title, displayed when the logo is not set. Defaults to the site's title. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a light navigation header.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* navbar path="blog" color="light" size="sm" search="false" menus="sample" title="Brand" */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Overview
|
|
||||||
date: 2023-01-14
|
|
||||||
description: Use predefined shortcodes to embed Bootstrap components in your content.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- TODO: expand -->
|
|
@@ -1,35 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Spinner
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the spinner shortcode to indicate the loading state of a component or page.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `spinner` shortcode to indicate the loading state of a component or page. The inner content is used as alternative description.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| color | No | Optional theme color of the spinner, either "primary" (default), "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". |
|
|
||||||
| grow | No | Optional flag to indicate the spinner is growing instead of rotating, defaults to false. |
|
|
||||||
| class | No | Optional class attribute of the spinner wrapping element, e.g. “text-center”. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a centered spinner.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* spinner color="info" class="text-center" */>}}
|
|
||||||
Loading...
|
|
||||||
{{</* /spinner */>}}
|
|
||||||
{{< /example>}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,37 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Toast
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the toast shortcode to display a dismissable message in the bottom-right corner of the screen.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `toast` shortcode to display a dismissable message in the bottom-right corner of the screen. Hinode defines a click event for a button with id `toastButton`. Modify the file `assets/js/toast.js` if needed.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| header | No | Optional header of the toast message. Uses the site title by default. |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a button that, when clicked, triggers the toast message.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* button id="toastButton" */>}}
|
|
||||||
Show toast
|
|
||||||
{{</* /button */>}}
|
|
||||||
|
|
||||||
{{</* toast header="Custom title" */>}}
|
|
||||||
This is a toast message.
|
|
||||||
{{</* /toast */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,36 +0,0 @@
|
|||||||
---
|
|
||||||
author: Mark Dumay
|
|
||||||
title: Tooltip
|
|
||||||
date: 2023-01-28
|
|
||||||
description: Use the toast shortcode to display a dismissable message in the bottom-right corner of the screen.
|
|
||||||
group: components
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Use the `tooltip` shortcode to display a tooltip for a hyperlink. Refer to the [button]({{< ref "#button" >}} "button") on how to display a tooltip for a button instead. The inner content is used as hyperlink text.
|
|
||||||
|
|
||||||
## Arguments
|
|
||||||
|
|
||||||
The shortcode supports the following arguments:
|
|
||||||
|
|
||||||
| Argument | Required | Description |
|
|
||||||
|-------------|----------|-------------|
|
|
||||||
| color | No | Optional theme color of the element, either "primary" (default), "secondary", "success", "danger", "warning", "info", "light", "dark", "white" or "black". |
|
|
||||||
| title | Yes | Title to display in the tooltip. |
|
|
||||||
| href | Yes | Address for the button or hyperlink. |
|
|
||||||
| placement | No | How to position the tooltip: "top" (default), "bottom", "left", or "right". |
|
|
||||||
{.table}
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
As an example, the following shortcode displays a tooltip for a colored hyperlink.
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD037 -->
|
|
||||||
{{< example lang="hugo" >}}
|
|
||||||
{{</* tooltip color="warning" title="Tooltip" href="#" */>}}
|
|
||||||
Tooltip demonstration
|
|
||||||
{{</* /tooltip */>}}
|
|
||||||
{{< /example >}}
|
|
||||||
<!-- markdownlint-enable MD037 -->
|
|
@@ -1,93 +0,0 @@
|
|||||||
---
|
|
||||||
title: Colors
|
|
||||||
description: Use Bootstrap's color system to easily adjust your website's colors.
|
|
||||||
date: 2023-01-14
|
|
||||||
group: configuration
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
## Theme colors
|
|
||||||
|
|
||||||
Hinode uses Bootstrap's color system. You can adjust them in the `/config/_default/params.toml` file in the `style` section.
|
|
||||||
|
|
||||||
{{< docs name="theme-colors" file="config/_default/params.toml" >}}
|
|
||||||
|
|
||||||
In addition, the background colors `black` and `white` are available too. Below is an overview of the rendered colors.
|
|
||||||
|
|
||||||
<div class="row">
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-primary rounded-3">Primary</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-secondary rounded-3">Secondary</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-success rounded-3">Success</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-danger rounded-3">Danger</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-warning rounded-3">Warning</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-info rounded-3">Info</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-light rounded-3">Light</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-dark rounded-3">Dark</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 text-bg-white rounded-3">White</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-black text-white rounded-3">Black</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Colored contrasting links
|
|
||||||
|
|
||||||
Hinode defines additional classes to render links that contrast with their background. Simply add `link-bg-<color>` to the class of an `<a>` anchor element. The next example adds a link constrasting with the background color `bg-success`.
|
|
||||||
|
|
||||||
{{< example >}}
|
|
||||||
<div class="col-md-2">
|
|
||||||
<div class="p-3 mb-3 bg-success rounded-3 text-center"><a class="link-bg-success" href="#">Success</a></div>
|
|
||||||
</div>
|
|
||||||
{{< /example>}}
|
|
||||||
|
|
||||||
Below grid illustrates the contrasting colors for each background.
|
|
||||||
|
|
||||||
<div class="row">
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-primary rounded-3"><a class="link-bg-primary" href="#">Primary</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-secondary rounded-3"><a class="link-bg-secondary" href="#">Secondary</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-success rounded-3"><a class="link-bg-success" href="#">Success</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-danger rounded-3"><a class="link-bg-danger" href="#">Danger</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-warning rounded-3"><a class="link-bg-warning" href="#">Warning</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-info rounded-3"><a class="link-bg-info" href="#">Info</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-light rounded-3"><a class="link-bg-light" href="#">Light</a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-md-4">
|
|
||||||
<div class="p-3 mb-3 bg-dark rounded-3"><a class="link-bg-dark" href="#">Dark</a></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## Generating helper
|
|
||||||
|
|
||||||
The SCSS generator for the colored links is defined in `assets/scss/helpers/_colored-links.scss`.
|
|
||||||
|
|
||||||
{{< docs name="colored-links" file="assets/scss/helpers/_colored-links.scss" >}}
|
|
@@ -1,9 +0,0 @@
|
|||||||
---
|
|
||||||
title: Comments
|
|
||||||
description:
|
|
||||||
date: 2023-01-14
|
|
||||||
group: configuration
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- TODO: expand -->
|
|
@@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
title: Fonts
|
|
||||||
description: Configure a specific font to style your website.
|
|
||||||
date: 2023-01-28
|
|
||||||
group: configuration
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Hinode uses a configurable font stack that includes support for Emoji across browsers and devices. Review the configuration settings below on how to update the font.
|
|
||||||
|
|
||||||
## Font configuration
|
|
||||||
|
|
||||||
Hinode uses Bootstrap's font configuration. The font stack includes support for Emoji across browsers and devices. You can adjust the main font in the `/config/_default/params.toml` file in the `style` section.
|
|
||||||
|
|
||||||
{{< docs name="font" file="config/_default/params.toml" >}}
|
|
||||||
|
|
||||||
By default, Hinode configures the `Inter` font provided by [Google Fonts]({{< param "links.google_fonts" >}}) with the weights 200, 300, and 600. If you use a different font provider, be sure to adjust the Content Security Policy in the [server configuration]({{< ref "server" >}}).
|
|
||||||
|
|
||||||
## Customization
|
|
||||||
|
|
||||||
The font stack is defined in the `assets/scss/common/_variables.scss` file. The variable `$themeFont` is initialized to the value in the [font configuration](#font-configuration).
|
|
||||||
|
|
||||||
{{< docs name="font" file="assets/scss/common/_variables.scss" >}}
|
|
@@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
title: Languages
|
|
||||||
description: Configure multiple languages to enable multilingual sites.
|
|
||||||
date: 2023-01-21
|
|
||||||
group: configuration
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
|
|
||||||
Hinode supports Hugo's [multilingual mode]({{< param "links.hugo_lang" >}}) to create websites with multiple languages side by side. The next paragraphs explain how to configure multiple languages, how to provide content translations, and how to define multilingual messages and keywords.
|
|
||||||
|
|
||||||
## Language configuration
|
|
||||||
|
|
||||||
Define the languages available to your site in the main site configuration. The below configuration shows the default configuration set in `config/_default/languages.toml` for the English language.
|
|
||||||
|
|
||||||
{{< docs name="lang-main" file="config/_default/languages.toml" >}}
|
|
||||||
|
|
||||||
The default behavior is set in `config/_default/config.toml`. For example, you can set the `defaultContentLanguageInSubdir` to `false` to remove the language slug `/en` from your site entirely.
|
|
||||||
|
|
||||||
{{< docs name="language" file="config/_default/config.toml" >}}
|
|
||||||
|
|
||||||
## Content translation
|
|
||||||
|
|
||||||
Hugo supports multiple ways to define translated content. Hinode uses an approach to define translations in separate directories for each language. In the default settings, content for the English language is defined in the folder `content/en`. It is recommended to use the same filename for each page translation. This enables Hugo to recognize if a page translation is available. Hinode links to this translation in the main navigation bar.
|
|
||||||
|
|
||||||
For example, consider the `About` page. It is available in both English and Dutch. The content files are defined in `content/en/about.md` and `content/nl/about.md`. Hugo now recognizes the page is available in two languages. To translate the URL for the Dutch page, a `slug` is defined the page's frontmatter:
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
slug: "over-mij"
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
The English page is available by navigating to `/en/about` and the Dutch translation is available on `/nl/over-mij`. The [main navigation]({{< ref "navigation#main-navigation" >}}) item shows a language switcher for both translations.
|
|
||||||
|
|
||||||
## Internationalization
|
|
||||||
|
|
||||||
Hinode uses Hugo's [internationalization function]({{< param "links.hugo_i18n" >}}) to translate keywords and messages. Translations are available in English, Dutch, and German. For example, the translation for the word `about` in the Dutch language is defined in `i18n/nl.yaml` (strictly speaking, it translates to `about me`).
|
|
||||||
|
|
||||||
```yml
|
|
||||||
# Content
|
|
||||||
- id: about
|
|
||||||
translation: "Over mij"
|
|
||||||
```
|
|