Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
insert_final_newline = true
2 changes: 1 addition & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
assets/js/index.js
assets/js/katex.js
assets/js/vendor
node_modules
node_modules
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@
}
]
}
}
}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ public
resources
# Local Netlify folder
.netlify
TODO
TODO
2 changes: 1 addition & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
"no-duplicate-heading": false,
"no-bare-urls": false,
"MD029": false
}
}
2 changes: 1 addition & 1 deletion .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
node_modules
CHANGELOG.md
README.md
README.md
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: mixed-line-ending
- id: check-added-large-files
args: ["--maxkb=1000"]
2 changes: 1 addition & 1 deletion .stylelintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
assets/scss/components/_syntax.scss
assets/scss/vendor
node_modules
node_modules
2 changes: 1 addition & 1 deletion .stylelintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
}
]
}
}
}
2 changes: 1 addition & 1 deletion archetypes/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ date: {{ .Date }}
lastmod: {{ .Date }}
draft: true
images: []
menu:
menu:
docs:
parent: ""
weight: 999
Expand Down
2 changes: 1 addition & 1 deletion babel.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ module.exports = {
}
]
]
};
};
18 changes: 18 additions & 0 deletions content/en/docs/help/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,21 @@ title: "Jonh Doe"
draft: false
---
```

## Before Commit

프로젝트에서는 각 글들의 일관성을 위해서 여러 lint를 적용하고 있습니다.
다음 명령어를 실행해 test를 진행합니다.

pre-commit을 통해 대부분의 test를 통과할 수 있습니다.

```bash
pip install pre-commit
pre-commit run -a
```

pre-commit 후 test를 진행합니다.

```bash
npm test
```
2 changes: 1 addition & 1 deletion i18n/en.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[get-started]
other = "Get Started"
other = "Get Started"
2 changes: 1 addition & 1 deletion i18n/nl.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[get-started]
other = "Aan de slag"
other = "Aan de slag"
2 changes: 1 addition & 1 deletion layouts/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ <h1 class="text-center">Page not found :(</h1>
</article>
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/_default/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@
{{ partial "footer/footer.html" . }}
{{ partial "footer/script-footer.html" . }}
</body>
</html>
</html>
2 changes: 1 addition & 1 deletion layouts/_default/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ var docs = [
href: "{{ .URL | relURL }}"
},
{{ end -}}
];
];
2 changes: 1 addition & 1 deletion layouts/_default/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
{{- range .Site.RegularPages -}}
{{- $.Scratch.Add "index" (dict "title" .Title "description" .Params.description "contents" .Plain "RelPermalink" .RelPermalink) -}}
{{- end -}}
{{- $.Scratch.Get "index" | jsonify -}}
{{- $.Scratch.Get "index" | jsonify -}}
2 changes: 1 addition & 1 deletion layouts/_default/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ <h2><a href="{{ .RelPermalink }}">{{ .Title }}</a></h2>
{{ template "_internal/pagination.html" . }}
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/_default/section.sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@
{{ end -}}
{{ end -}}
{{ end -}}
</urlset>
</urlset>
2 changes: 1 addition & 1 deletion layouts/blog/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ <h2 class="h3"><a class="stretched-link text-body" href="{{ .RelPermalink }}">{{
</article>
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/blog/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ <h1>{{ .Title }}</h1>
</article>
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/contributors/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ <h2 class="h3"><a class="stretched-link text-body" href="{{ .RelPermalink }}">{{
</article>
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/docs/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ <h1 class="text-center">{{ .Title }}</h1>
</article>
</div>
</div>
{{ end }}
{{ end }}
2 changes: 1 addition & 1 deletion layouts/index.headers
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
Referrer-Policy: strict-origin
Feature-Policy: geolocation 'self'
Cache-Control: public, max-age=31536000
Access-Control-Allow-Origin: *
Access-Control-Allow-Origin: *
2 changes: 1 addition & 1 deletion layouts/partials/footer/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
</div>
</div>
</div>
</footer>
</footer>
2 changes: 1 addition & 1 deletion layouts/partials/footer/script-footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@
{{ if and (.Site.Params.options.flexSearch) (eq .Section "docs") -}}
<script src="{{ $index.Permalink }}" integrity="{{ $index.Data.Integrity }}" crossorigin="anonymous" defer></script>
{{ end -}}
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/head/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
{{ block "head/stylesheet" . }}{{ partial "head/stylesheet.html" . }}{{ end }}
{{ block "head/seo" . }}{{ partial "head/seo.html" . }}{{ end }}
{{ block "head/favicons" . }}{{ partial "head/favicons.html" . }}{{ end }}
</head>
</head>
2 changes: 1 addition & 1 deletion layouts/partials/head/resource-hints.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
{{ if .Site.Params.options.kaTex -}}
<link rel="preload" as="font" href="{{ "fonts/KaTeX_Main-Regular.woff2" | absURL }}" type="font/woff2" crossorigin>
<link rel="preload" as="font" href="{{ "fonts/KaTeX_Math-Italic.woff2" | absURL }}" type="font/woff2" crossorigin>
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/head/script-header.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{ if .Site.Params.options.darkMode -}}
{{ $darkModeInit := resources.Get "js/darkmode-init.js" | js.Build | minify -}}
<script>{{ $darkModeInit.Content | safeJS }}</script>
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/head/structured-data.html
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,4 @@

]
}
</script>
</script>
2 changes: 1 addition & 1 deletion layouts/partials/head/stylesheet.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
{{ $secureCSS := $css | resources.Fingerprint "sha512" -}}
<link rel="stylesheet" href="{{ $secureCSS.Permalink }}" integrity="{{ $secureCSS.Data.Integrity }}" crossorigin="anonymous">
{{ end -}}
<noscript><style>img.lazyload { display: none; }</style></noscript>
<noscript><style>img.lazyload { display: none; }</style></noscript>
2 changes: 1 addition & 1 deletion layouts/partials/head/twitter_cards.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
{{ end -}}
{{ end -}}
{{ end -}}
<meta name="twitter:image:alt" content="{{ .Title }}">
<meta name="twitter:image:alt" content="{{ .Title }}">
2 changes: 1 addition & 1 deletion layouts/partials/main/blog-meta.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<p><small>Posted {{ .PublishDate.Format "January 2, 2006" }} by {{ if .Params.contributors -}}{{ range $index, $contributor := .Params.contributors }}{{ if gt $index 0 }} and {{ end }}<a class="stretched-link position-relative" href="{{ "/contributors/" | relURL }}{{ . | urlize }}/">{{ . }}</a>{{ end -}}{{ end -}}&nbsp;&hyphen;&nbsp;<strong>{{ .ReadingTime -}}&nbsp;min read</strong></small><p>
<p><small>Posted {{ .PublishDate.Format "January 2, 2006" }} by {{ if .Params.contributors -}}{{ range $index, $contributor := .Params.contributors }}{{ if gt $index 0 }} and {{ end }}<a class="stretched-link position-relative" href="{{ "/contributors/" | relURL }}{{ . | urlize }}/">{{ . }}</a>{{ end -}}{{ end -}}&nbsp;&hyphen;&nbsp;<strong>{{ .ReadingTime -}}&nbsp;min read</strong></small><p>
2 changes: 1 addition & 1 deletion layouts/partials/main/breadcrumb.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{ with .Parent -}}
{{ partial "main/breadcrumb.html" . -}}
<li class="breadcrumb-item"><a href="{{ .RelPermalink }}">{{ if .IsHome }}Home{{ else }}{{ .Title }}{{ end }}</a></li>
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/main/docs-navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
</a>
{{ end -}}
</div>
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/sidebar/docs-menu.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ <h3 class="h6 text-uppercase">{{ .Name }}</h3>
</ul>
{{ end -}}
{{ end -}}
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/shortcodes/email.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<script type="text/javascript" nonce="dXNlcj0iaGVsbG8iLGRvbWFpbj0iaGVua3ZlcmxpbmRlLmNvbSIsZG9jdW1lbnQud3JpdGUodXNlcisiQCIrZG9tYWluKTs=">user="{{ with .Get "user" }}{{.}}{{ end }}",domain="{{ with .Get "domain" }}{{.}}{{ end }}",document.write(user+"@"+domain);</script><noscript>{{ with .Get "user" }}{{.}}{{ end }} at {{ with .Get "domain" }}{{.}}{{ end }}</noscript>
<script type="text/javascript" nonce="dXNlcj0iaGVsbG8iLGRvbWFpbj0iaGVua3ZlcmxpbmRlLmNvbSIsZG9jdW1lbnQud3JpdGUodXNlcisiQCIrZG9tYWluKTs=">user="{{ with .Get "user" }}{{.}}{{ end }}",domain="{{ with .Get "domain" }}{{.}}{{ end }}",document.write(user+"@"+domain);</script><noscript>{{ with .Get "user" }}{{.}}{{ end }} at {{ with .Get "domain" }}{{.}}{{ end }}</noscript>
2 changes: 1 addition & 1 deletion layouts/shortcodes/img-simple.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<img class="img-simple img-fluid lazyload blur-up{{ with .Get "class" }} {{.}}{{ end }}" src="{{ $lqip.RelPermalink }}" data-src="{{ $image.RelPermalink }}" width="{{ $image.Width }}" height="{{ $image.Height }}" {{ with .Get "alt" }}alt="{{.}}"{{ end }}>
{{ else -}}
<img class="img-simple img-fluid{{ with .Get "class" }} {{.}}{{ end }}" src="{{ $image.RelPermalink }}" width="{{ $image.Width }}" height="{{ $image.Height }}" {{ with .Get "alt" }}alt="{{.}}"{{ end }}>
{{ end -}}
{{ end -}}
2 changes: 1 addition & 1 deletion static/doks.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion static/logo-doks.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion static/site.webmanifest
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"name":"Doks Theme","short_name":"Doks","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#fff","background_color":"#fff","display":"standalone"}
{"name":"Doks Theme","short_name":"Doks","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#fff","background_color":"#fff","display":"standalone"}