diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..177d9f2e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..694b1bf2 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,40 @@ +# https://github.com/gohugoio/hugo/blob/b39b24962350090122b5f3927456dde710cffb57/docs/.prettierignore +# https://github.com/gohugoio/hugo/blob/b39b24962350090122b5f3927456dde710cffb57/docs/.prettierrc + +# develop +.vscode +node_modules +package.json + +# Hugo +assets/lib +assets/css/compiled +content +themes +public +static +*.md + +# Invalid nodes and unexpected tokens, mostly caused by unmatched tags in Hugo statements. +# For example: +# {{ with .Params.externalUrl }} +# +# {{ else }} +# +# {{ end }} +# +# This create an unclose node + +layouts/_default/_markup/render-heading.html +layouts/_default/index.json +layouts/_default/list.html +layouts/partials/article-link/card-related.html +layouts/partials/article-link/card.html +layouts/partials/article-link/simple.html +layouts/partials/header/basic.html +layouts/partials/hero/background.html +layouts/partials/head.html +layouts/shortcodes/screenshot.html +layouts/shortcodes/figure.html + +assets/js/appearance.js diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..081022e5 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,45 @@ +{ + "singleQuote": false, + "tabWidth": 2, + "useTabs": false, + "semi": true, + "trailingComma": "all", + "proseWrap": "always", + "plugins": [ + "prettier-plugin-go-template", + "@awmottaz/prettier-plugin-void-html" + ], + "overrides": [ + { + "files": ["*.html"], + "options": { + "useTabs": false, + "parser": "go-template", + "goTemplateBracketSpacing": true, + "printWidth": 112, + "bracketSameLine": true + } + }, + { + "files": ["*.js", "*.mjs", "*.mts", "*.ts"], + "options": { + "semi": true, + "useTabs": false, + "printWidth": 112, + "singleQuote": false + } + }, + { + "files": ["*.yml", "*.yaml"], + "options": { + "singleQuote": false + } + }, + { + "files": ["*.json*"], + "options": { + "trailingComma": "none" + } + } + ] +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60f27349..8639f1c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,7 +45,7 @@ The project includes a Prettier config that helps to format code in line with th #### Commit message guidelines -- Use [Gitmoji](https://gitmoji.dev) in commit messages to provide context. +- Use [Gitmoji](https://gitmoji.dev) in PR messages to provide context. - Clearly describe the change with a short summary in the first 72 characters. - Place more detailed explanations in paragraphs below the summary, separated by a blank line. - Use imperative language (ie. "Fix bug", not "Fixed bug" or "Fixes bug"). diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index 6100a56c..85d63a1a 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -67,12 +67,3 @@ enableEmoji = true name = 'fragmentrefs' type = 'fragments' weight = 10 - -[markup] - [markup.goldmark] - [markup.goldmark.extensions] - [markup.goldmark.extensions.passthrough] - enable = true - [markup.goldmark.extensions.passthrough.delimiters] - block = [['\[', '\]'], ['$$', '$$']] - inline = [['\(', '\)']] diff --git a/config/_default/markup.toml b/config/_default/markup.toml index c5449fc3..fccbfcc2 100644 --- a/config/_default/markup.toml +++ b/config/_default/markup.toml @@ -2,8 +2,15 @@ # These settings are required for the theme to function. [goldmark] -[goldmark.renderer] - unsafe = true + [goldmark.renderer] + unsafe = true + + [goldmark.extensions] + [goldmark.extensions.passthrough] + enable = true + [goldmark.extensions.passthrough.delimiters] + block = [['\[', '\]'], ['$$', '$$']] + inline = [['\(', '\)']] [highlight] noClasses = false diff --git a/exampleSite/config/_default/markup.toml b/exampleSite/config/_default/markup.toml index c5449fc3..fccbfcc2 100644 --- a/exampleSite/config/_default/markup.toml +++ b/exampleSite/config/_default/markup.toml @@ -2,8 +2,15 @@ # These settings are required for the theme to function. [goldmark] -[goldmark.renderer] - unsafe = true + [goldmark.renderer] + unsafe = true + + [goldmark.extensions] + [goldmark.extensions.passthrough] + enable = true + [goldmark.extensions.passthrough.delimiters] + block = [['\[', '\]'], ['$$', '$$']] + inline = [['\(', '\)']] [highlight] noClasses = false diff --git a/exampleSite/content/docs/partials/index.it.md b/exampleSite/content/docs/partials/index.it.md index 13225e0d..c522aaba 100644 --- a/exampleSite/content/docs/partials/index.it.md +++ b/exampleSite/content/docs/partials/index.it.md @@ -137,3 +137,11 @@ If you wish to insert additional code after article links, create a `layouts/par The theme allows for inserting additional code directly into the `` and `