diff options
Diffstat (limited to 'themes/CodeIT/exampleSite/content/posts/theme-documentation-basics/index.fr.md')
| -rw-r--r-- | themes/CodeIT/exampleSite/content/posts/theme-documentation-basics/index.fr.md | 1053 |
1 files changed, 0 insertions, 1053 deletions
diff --git a/themes/CodeIT/exampleSite/content/posts/theme-documentation-basics/index.fr.md b/themes/CodeIT/exampleSite/content/posts/theme-documentation-basics/index.fr.md deleted file mode 100644 index cc879f6..0000000 --- a/themes/CodeIT/exampleSite/content/posts/theme-documentation-basics/index.fr.md +++ /dev/null @@ -1,1053 +0,0 @@ ---- -weight: 1 -title: "Thème Documentation - Concepts de Base" -date: 2020-03-06T21:40:32+08:00 -lastmod: 2020-03-06T21:40:32+08:00 -draft: false -author: "Sunt Programator!" -authorLink: "https://suntprogramator.dev/" -description: "Découvrez en quoi consiste le thème Hugo - CodeIT et les concepts fondamentaux qui le sous-tendent." -resources: - - name: "featured-image" - src: "featured-image.jpg" - -tags: ["installation", "configuration"] -categories: ["documentation"] - -lightgallery: true - -toc: - auto: false ---- - -Découvrez en quoi consiste le thème Hugo - **CodeIT** et les concepts fondamentaux qui le sous-tendent. - -<!--more--> - -{{< admonition warning >}} -Sorry, this article has not been completely translated into **French**. -Welcome to take the time to propose a translation by [:(fas fa-code-branch fa-fw): making a PR](https://github.com/sunt-programator/CodeIT/pulls) to the theme! -{{< /admonition >}} - -## 1 Requirements - -Thanks to the simplicity of Hugo, [Hugo](https://gohugo.io/) is the only dependency of this theme. - -Just install latest version of [:(far fa-file-archive fa-fw): Hugo (> 0.78.1)](https://gohugo.io/getting-started/installing/) for your OS (**Windows**, **Linux**, **macOS**). - -{{< admonition tip "Hugo extended version is recommended" >}} -Since some features of this theme need to processes :(fab fa-sass fa-fw): SCSS to :(fab fa-css3 fa-fw): CSS, it is recommended to use Hugo **extended** version for better experience. -{{< /admonition >}} - -## 2 Installation - -The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/getting-started/quick-start/). - -### 2.1 Create Your Project - -Hugo provides a `new` command to create a new website: - -```bash -hugo new site my_website -cd my_website -``` - -### 2.2 Install the Theme - -The **CodeIT** theme’s repository is: [https://github.com/sunt-programator/CodeIT](https://github.com/sunt-programator/CodeIT). - -You can download the [latest release :(far fa-file-archive fa-fw): .zip file](https://github.com/sunt-programator/CodeIT/releases) of the theme and extract it in the `themes` directory. - -Alternatively, clone this repository to the `themes` directory: - -```bash -git clone https://github.com/sunt-programator/CodeIT.git themes/CodeIT -``` - -Or, create an empty git repository and make this repository a submodule of your site directory: - -```bash -git init -git submodule add https://github.com/sunt-programator/CodeIT.git themes/CodeIT -``` - -### 2.3 Basic Configuration {#basic-configuration} - -The following is a basic configuration for the CodeIT theme: - -```toml -baseURL = "http://example.org/" -# [en, zh-cn, fr, ...] determines default content language -defaultContentLanguage = "en" -# language code -languageCode = "en" -title = "My New Hugo Site" - -# Change the default theme to be use when building the site with Hugo -theme = "CodeIT" - -[params] - # CodeIT theme version - version = "0.2.X" - -[menu] - [[menu.main]] - identifier = "posts" - # you can add extra information before the name (HTML format is supported), such as icons - pre = "" - # you can add extra information after the name (HTML format is supported), such as icons - post = "" - name = "Posts" - url = "/posts/" - # title will be shown when you hover on this menu link - title = "" - weight = 1 - [[menu.main]] - identifier = "tags" - pre = "" - post = "" - name = "Tags" - url = "/tags/" - title = "" - weight = 2 - [[menu.main]] - identifier = "categories" - pre = "" - post = "" - name = "Categories" - url = "/categories/" - title = "" - weight = 3 - -# Markup related configuration in Hugo -[markup] - # Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting) - [markup.highlight] - # false is a necessary configuration (https://github.com/sunt-programator/CodeIT/issues/158) - noClasses = false -``` - -{{< admonition >}} -When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (**config.toml**) and set the theme as the default. -{{< /admonition >}} - -### 2.4 Create Your First Post - -Here is the way to create your first post: - -```bash -hugo new posts/first_post.md -``` - -Feel free to edit the post file by adding some sample content and replacing the title value in the beginning of the file. - -{{< admonition >}} -By default all posts and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata, set the property `draft: false` or add `-D`/`--buildDrafts` parameter to `hugo` command. -{{< /admonition >}} - -### 2.5 Launching the Website Locally - -Launch by using the following command: - -```bash -hugo serve -``` - -Go to `http://localhost:1313`. - - - -{{< admonition tip >}} -When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. -{{< /admonition >}} - -{{< admonition >}} -Since the theme use `.Scratch` in Hugo to implement some features, -it is highly recommended that you add `--disableFastRender` parameter to `hugo server` command for the live preview of the page you are editing. - -```bash -hugo serve --disableFastRender -``` - -{{< /admonition >}} - -### 2.6 Build the Website - -When your site is ready to deploy, run the following command: - -```bash -hugo -``` - -A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server. - -{{< admonition tip >}} -The website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). -Alternatively, you can use [AWS Amplify](https://gohugo.io/hosting-and-deployment/hosting-on-aws-amplify/), [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/), [Render](https://gohugo.io/hosting-and-deployment/hosting-on-render/) and more... -{{< /admonition >}} - -## 3 Configuration - -### 3.1 Site Configuration {#site-configuration} - -In addition to [Hugo global configuration](https://gohugo.io/overview/configuration/) and [menu configuration](#basic-configuration), **CodeIT** lets you define the following parameters in your site configuration (here is a `config.toml`, whose values are default). - -Please open the code block below to view the complete sample configuration :(far fa-hand-point-down fa-fw):: - -```toml -[params] - # CodeIT theme version - version = "0.2.X" - # site description - description = "This is My New Hugo Site" - # site keywords - keywords = ["Theme", "Hugo"] - # site default theme ("light", "dark", "auto") - defaultTheme = "auto" - # public git repo url only then enableGitInfo is true - gitRepo = "" - # which hash function used for SRI, when empty, no SRI is used - # ("sha256", "sha384", "sha512", "md5") - fingerprint = "" - # date format - dateFormat = "2006-01-02" - # website images for Open Graph and Twitter Cards - images = ["/logo.png"] - - # App icon config - [params.app] - # optional site title override for the app when added to an iOS home screen or Android launcher - title = "CodeIT" - # whether to omit favicon resource links - noFavicon = false - # modern SVG favicon to use in place of older style .png and .ico files - svgFavicon = "" - # Android browser theme color - themeColor = "#ffffff" - # Safari mask icon color - iconColor = "#5bbad5" - # Windows v8-10 tile color - tileColor = "#da532c" - - # Search config - [params.search] - enable = true - # type of search engine ("lunr", "algolia") - type = "lunr" - # max index length of the chunked content - contentLength = 4000 - # placeholder of the search bar - placeholder = "" - # max number of results length - maxResultLength = 10 - # snippet length of the result - snippetLength = 30 - # HTML tag name of the highlight part in results - highlightTag = "em" - # whether to use the absolute URL based on the baseURL in search index - absoluteURL = false - [params.search.algolia] - index = "" - appID = "" - searchKey = "" - - # Header config - [params.header] - # desktop header mode ("fixed", "normal", "auto") - desktopMode = "fixed" - # mobile header mode ("fixed", "normal", "auto") - mobileMode = "auto" - # Header title config - [params.header.title] - # URL of the LOGO - logo = "" - # title name - name = "" - # you can add extra information before the name (HTML format is supported), such as icons - pre = "" - # you can add extra information after the name (HTML format is supported), such as icons - post = "" - # whether to use typeit animation for title name - typeit = false - - # Footer config - [params.footer] - enable = true - # Custom content (HTML format is supported) - custom = '' - # whether to show Hugo and theme info - hugo = true - # whether to show copyright info - copyright = true - # whether to show the author - author = true - # Site creation time - since = 2019 - # ICP info only in China (HTML format is supported) - icp = "" - # license info (HTML format is supported) - license = '<a rel="license external nofollow noopener noreffer" href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">CC BY-NC 4.0</a>' - - # Section (all posts) page config - [params.section] - # special amount of posts in each section page - paginate = 20 - # date format (month and day) - dateFormat = "01-02" - # amount of RSS pages - rss = 10 - - # List (category or tag) page config - [params.list] - # special amount of posts in each list page - paginate = 20 - # date format (month and day) - dateFormat = "01-02" - # amount of RSS pages - rss = 10 - - # Home page config - [params.home] - # amount of RSS pages - rss = 10 - # Home page profile - [params.home.profile] - enable = true - # Gravatar Email for preferred avatar in home page - gravatarEmail = "" - # URL of avatar shown in home page - avatarURL = "/images/avatar.png" - # {{< version 0.1.1 >}} Alt text for avatar (default is the author name) - avatarAlt = "" - # title shown in home page (HTML format is supported) - title = "" - # subtitle shown in home page - # {{< version 0.1.1 changed >}} (HTML format is supported) - subtitle = "This is My New Hugo Site" - # whether to use typeit animation for subtitle - typeit = true - # whether to show social links - social = true - # disclaimer (HTML format is supported) - disclaimer = "" - # Home page posts - [params.home.posts] - enable = true - # special amount of posts in each home posts page - paginate = 6 - # replaced with hiddenFromHomePage in params.page - # default behavior when you don't set "hiddenFromHomePage" in front matter - defaultHiddenFromHomePage = false - - # Social config about the author - [params.social] - GitHub = "xxxx" - Linkedin = "" - Twitter = "xxxx" - Instagram = "xxxx" - Facebook = "xxxx" - Telegram = "xxxx" - Medium = "" - Gitlab = "" - Youtubelegacy = "" - Youtubecustom = "" - Youtubechannel = "" - Tumblr = "" - Quora = "" - Keybase = "" - Pinterest = "" - Reddit = "" - Codepen = "" - FreeCodeCamp = "" - Bitbucket = "" - Stackoverflow = "" - Weibo = "" - Odnoklassniki = "" - VK = "" - Flickr = "" - Xing = "" - Snapchat = "" - Soundcloud = "" - Spotify = "" - Bandcamp = "" - Paypal = "" - Fivehundredpx = "" - Mix = "" - Goodreads = "" - Lastfm = "" - Foursquare = "" - Hackernews = "" - Kickstarter = "" - Patreon = "" - Steam = "" - Twitch = "" - Strava = "" - Skype = "" - Whatsapp = "" - Zhihu = "" - Douban = "" - Angellist = "" - Slidershare = "" - Jsfiddle = "" - Deviantart = "" - Behance = "" - Dribbble = "" - Wordpress = "" - Vine = "" - Googlescholar = "" - Researchgate = "" - Mastodon = "" - Thingiverse = "" - Devto = "" - Gitea = "" - XMPP = "" - Matrix = "" - Bilibili = "" - Email = "xxxx@xxxx.com" - RSS = true - # {{< version 0.1.2 >}} Open Researcher and Contributor ID - Orcid = "" - - # Page config - [params.page] - # whether to hide a page from home page - hiddenFromHomePage = false - # whether to hide a page from search results - hiddenFromSearch = false - # whether to enable twemoji - twemoji = false - # whether to enable lightgallery - lightgallery = false - # whether to enable the ruby extended syntax - ruby = true - # whether to enable the fraction extended syntax - fraction = true - # whether to enable the fontawesome extended syntax - fontawesome = true - # whether to show link to Raw Markdown content of the content - linkToMarkdown = true - # whether to show the full text content in RSS - rssFullText = false - # Table of the contents config - [params.page.toc] - # whether to enable the table of the contents - enable = true - # whether to keep the static table of the contents in front of the post - keepStatic = true - # whether to make the table of the contents in the sidebar automatically collapsed - auto = true - # {{< link "https://katex.org/" KaTeX >}} mathematical formulas - [params.page.math] - enable = true - # default block delimiter is $$ ... $$ and \\[ ... \\] - blockLeftDelimiter = "" - blockRightDelimiter = "" - # default inline delimiter is $ ... $ and \\( ... \\) - inlineLeftDelimiter = "" - inlineRightDelimiter = "" - # KaTeX extension copy_tex - copyTex = true - # KaTeX extension mhchem - mhchem = true - # Code config - [params.page.code] - # whether to show the copy button of the code block - copy = true - # the maximum number of lines of displayed code by default - maxShownLines = 10 - # {{< link "https://docs.mapbox.com/mapbox-gl-js" "Mapbox GL JS" >}} config - [params.page.mapbox] - # access token of Mapbox GL JS - accessToken = "" - # style for the light theme - lightStyle = "mapbox://styles/mapbox/light-v9" - # style for the dark theme - darkStyle = "mapbox://styles/mapbox/dark-v9" - # whether to add {{< link "https://docs.mapbox.com/mapbox-gl-js/api#navigationcontrol" NavigationControl >}} - navigation = true - # whether to add {{< link "https://docs.mapbox.com/mapbox-gl-js/api#geolocatecontrol" GeolocateControl >}} - geolocate = true - # whether to add {{< link "https://docs.mapbox.com/mapbox-gl-js/api#scalecontrol" ScaleControl >}} - scale = true - # whether to add {{< link "https://docs.mapbox.com/mapbox-gl-js/api#fullscreencontrol" FullscreenControl >}} - fullscreen = true - # social share links in post page - [params.page.share] - enable = true - Twitter = true - Facebook = true - Linkedin = false - Whatsapp = true - Pinterest = false - Tumblr = false - HackerNews = false - Reddit = false - VK = false - Buffer = false - Xing = false - Line = true - Instapaper = false - Pocket = false - Digg = false - Stumbleupon = false - Flipboard = false - Weibo = true - Renren = false - Myspace = true - Blogger = true - Baidu = false - Odnoklassniki = false - Evernote = true - Skype = false - Trello = false - Mix = false - # {{< version 0.1.2 >}} - Telegram = false - # Comment config - [params.page.comment] - enable = true - # {{< link "https://disqus.com/" Disqus >}} comment config - [params.page.comment.disqus] - enable = false - # Disqus shortname to use Disqus in posts - shortname = "" - # {{< link "https://github.com/gitalk/gitalk" Gitalk >}} comment config - [params.page.comment.gitalk] - enable = false - owner = "" - repo = "" - clientId = "" - clientSecret = "" - # {{< link "https://github.com/xCss/Valine" Valine >}} comment config - [params.page.comment.valine] - enable = false - appId = "" - appKey = "" - placeholder = "" - avatar = "mp" - meta= "" - pageSize = 10 - lang = "" - visitor = true - recordIP = true - highlight = true - enableQQ = false - serverURLs = "" - # emoji data file name, default is "google.yml" - # ("apple.yml", "google.yml", "facebook.yml", "twitter.yml") - # located in "themes/CodeIT/assets/data/emoji/" directory - # you can store your own data files in the same path under your project: - # "assets/data/emoji/" - emoji = "" - # {{< link "https://developers.facebook.com/docs/plugins/comments" "Facebook comment" >}} config - [params.page.comment.facebook] - enable = false - width = "100%" - numPosts = 10 - appId = "" - languageCode = "" - # {{< link "https://comments.app/" "Telegram comments" >}} config - [params.page.comment.telegram] - enable = false - siteID = "" - limit = 5 - height = "" - color = "" - colorful = true - dislikes = false - outlined = false - # {{< link "https://commento.io/" "Commento" >}} comment config - [params.page.comment.commento] - enable = false - # {{< link "https://utteranc.es/" "Utterances" >}} comment config - [params.page.comment.utterances] - enable = false - # owner/repo - repo = "" - issueTerm = "pathname" - label = "" - lightTheme = "github-light" - darkTheme = "github-dark" - # {{< version 0.2.0 >}} {{< link "https://waline.js.org/en/" "Waline" >}} comment config - [params.page.comment.waline] - enable = false - serverURL = "https://xxx.vercel.com" - visitor = true - dark = 'auto' - # {{< version 0.2.0 >}} {{< link "https://twikoo.js.org" "Twikoo" >}} comment config - [params.page.comment.twikoo] - enable = false - evnId = "https://xxx.vercel.com" - # Third-party library config - [params.page.library] - [params.page.library.css] - # someCSS = "some.css" - # located in "assets/" - # Or - # someCSS = "https://cdn.example.com/some.css" - [params.page.library.js] - # someJavascript = "some.js" - # located in "assets/" - # Or - # someJavascript = "https://cdn.example.com/some.js" - # Page SEO config - [params.page.seo] - # image URL - images = [] - # Publisher info - [params.page.seo.publisher] - name = "" - logoUrl = "" - - # TypeIt config - [params.typeit] - # typing speed between each step (measured in milliseconds) - speed = 100 - # blinking speed of the cursor (measured in milliseconds) - cursorSpeed = 1000 - # character used for the cursor (HTML format is supported) - cursorChar = "|" - # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited) - duration = -1 - - # Site verification code config for Google/Bing/Yandex/Pinterest/Baidu - [params.verification] - google = "" - bing = "" - yandex = "" - pinterest = "" - baidu = "" - - # Site SEO config - [params.seo] - # image URL - image = "" - # thumbnail URL - thumbnailUrl = "" - - # Analytics config - [params.analytics] - enable = false - # Google Analytics - [params.analytics.google] - id = "" - # whether to anonymize IP - anonymizeIP = true - # Fathom Analytics - [params.analytics.fathom] - id = "" - # server url for your tracker if you're self hosting - server = "" - # {{< version 0.1.0 >}} Plausible Analytics - [params.analytics.plausible] - domain = "" - - # Cookie consent config - [params.cookieconsent] - enable = true - # text strings used for Cookie consent banner - [params.cookieconsent.content] - message = "" - dismiss = "" - link = "" - - # CDN config for third-party library files - [params.cdn] - # CDN data file name, disabled by default - # ("jsdelivr.yml") - # located in "themes/CodeIT/assets/data/cdn/" directory - # you can store your own data files in the same path under your project: - # "assets/data/cdn/" - data = "" - - # Compatibility config - [params.compatibility] - # whether to use Polyfill.io to be compatible with older browsers - polyfill = false - # whether to use object-fit-images to be compatible with older browsers - objectFit = false - -# Markup related config in Hugo -[markup] - # {{< link "https://gohugo.io/content-management/syntax-highlighting" "Syntax Highlighting" >}} - [markup.highlight] - codeFences = true - guessSyntax = true - lineNos = true - lineNumbersInTable = true - # false is a necessary configuration - # ({{< link "https://github.com/sunt-programator/CodeIT/issues/158" >}}) - noClasses = false - # Goldmark is from Hugo 0.60 the default library used for Markdown - [markup.goldmark] - [markup.goldmark.extensions] - definitionList = true - footnote = true - linkify = true - strikethrough = true - table = true - taskList = true - typographer = true - [markup.goldmark.renderer] - # whether to use HTML tags directly in the document - unsafe = true - # Table Of Contents settings - [markup.tableOfContents] - startLevel = 2 - endLevel = 6 - -# Author config -[author] - name = "xxxx" - email = "" - link = "" - -# Sitemap config -[sitemap] - changefreq = "weekly" - filename = "sitemap.xml" - priority = 0.5 - -# {{< link "https://gohugo.io/content-management/urls#permalinks" "Permalinks config" >}} -[Permalinks] - # posts = ":year/:month/:filename" - posts = ":filename" - -# {{< link "https://gohugo.io/about/hugo-and-gdpr/" "Privacy config" >}} -[privacy] - # privacy of the Google Analytics (replaced by params.analytics.google) - [privacy.googleAnalytics] - # ... - [privacy.twitter] - enableDNT = true - [privacy.youtube] - privacyEnhanced = true - -# Options to make output .md files -[mediaTypes] - [mediaTypes."text/plain"] - suffixes = ["md"] - -# Options to make output .md files -[outputFormats.MarkDown] - mediaType = "text/plain" - isPlainText = true - isHTML = false - -# Options to make hugo output files -[outputs] - home = ["HTML", "RSS", "JSON"] - page = ["HTML", "MarkDown"] - section = ["HTML", "RSS"] - taxonomy = ["HTML", "RSS"] - taxonomyTerm = ["HTML"] -``` - -{{< admonition >}} -Note that some of these parameters are explained in details in other sections of this documentation. -{{< /admonition >}} - -{{< admonition note "Hugo environments" >}} -Default environments are `development` with `hugo serve` and `production` with `hugo`. - -Due to limitations in the local `development` environment, -the **comment system**, **CDN** and **fingerprint** will not be enabled in the `development` environment. - -You could enable these features with `hugo serve -e production`. -{{< /admonition >}} - -{{< admonition tip "Tips about CDN Configuration" >}} - -```toml -[params.cdn] - # CDN data file name, disabled by default - # ("jsdelivr.yml") - data = "" -``` - -The default CDN data file is located in `themes/CodeIT/assets/data/cdn/` directory. -You can store your own data file in the same path under your project: `assets/data/cdn/`. -{{< /admonition >}} - -{{< admonition tip "Tips about social Configuration" >}} - -You can directly set your ID to get a default social link and its icon: - -```toml -[params.social] - Mastodon = "@xxxx" -``` - -The social link generated is `https://mastodon.technology/@xxxx`. - -Or You can set more options through a dict: - -```toml -[params.social] - [params.social.Mastodon] - # weight when arranging icons (the greater the weight, the later the icon is positioned) - weight = 0 - # your social ID - id = "@xxxx" - # prefix of your social link - prefix = "https://mastodon.social/" - # content hovering on the icon - title = "Mastodon" -``` - -The default data of all supported social links is located in `themes/CodeIT/assets/data/social.yaml`, -which is you can refer to. -{{< /admonition >}} - - - -### 3.2 Favicons, Browserconfig, Manifest - -It is recommended to put your own favicons: - -- apple-touch-icon.png (180x180) -- favicon-32x32.png (32x32) -- favicon-16x16.png (16x16) -- mstile-150x150.png (150x150) -- android-chrome-192x192.png (192x192) -- android-chrome-512x512.png (512x512) - -into `/static`. They’re easily created via [https://realfavicongenerator.net/](https://realfavicongenerator.net/). - -Customize `browserconfig.xml` and `site.webmanifest` to set theme-color and background-color. - -### 3.3 Style Customization - -{{< admonition >}} -Hugo **extended** version is necessary for the style customization. -{{< /admonition >}} - -**CodeIT** theme has been built to be as configurable as possible by defining custom `.scss` style files. - -The directory including the custom `.scss` style files is `assets/css` relative to **your project root directory**. - -In `assets/css/_override.scss`, you can override the variables in `themes/CodeIT/assets/css/_variables.scss` to customize the style. - -Here is a example: - -```scss -@import url("https://fonts.googleapis.com/css?family=Fira+Mono:400,700&display=swap&subset=latin-ext"); -$code-font-family: Fira Mono, Source Code Pro, Menlo, Consolas, Monaco, - monospace; -``` - -In `assets/css/_custom.scss`, you can add some css style code to customize the style. - -## 4 Multilingual and i18n - -**CodeIT** theme is fully compatible with Hugo multilingual mode, which provides in-browser language switching. - - - -### 4.1 Compatibility {#language-compatibility} - -| Language | Hugo Code | HTML `lang` Attribute | Theme Docs | Lunr.js Support | -| :------------------- | :-------: | :-------------------: | :---------------------------: | :---------------------------: | -| English | `en` | `en` | :(far fa-check-square fa-fw): | :(far fa-check-square fa-fw): | -| Simplified Chinese | `zh-cn` | `zh-CN` | :(far fa-check-square fa-fw): | :(far fa-check-square fa-fw): | -| French | `fr` | `fr` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Polish | `pl` | `pl` | :(far fa-square fa-fw): | :(far fa-square fa-fw): | -| Brazilian Portuguese | `pt-br` | `pt-BR` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Italian | `it` | `it` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Spanish | `es` | `es` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| German | `de` | `de` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| German | `de` | `de` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Serbian | `sr` | `sr` | :(far fa-square fa-fw): | :(far fa-square fa-fw): | -| Russian | `ru` | `ru` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Romanian | `ro` | `ro` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | -| Vietnamese | `vi` | `vi` | :(far fa-square fa-fw): | :(far fa-check-square fa-fw): | - -### 4.2 Basic Configuration - -After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your [site configuration](#site-configuration). - -For example with English, Chinese and French website: - -```toml -# [en, zh-cn, fr, pl, ...] determines default content language -defaultContentLanguage = "en" - -[languages] - [languages.en] - weight = 1 - title = "My New Hugo Site" - languageCode = "en" - languageName = "English" - [[languages.en.menu.main]] - identifier = "posts" - pre = "" - post = "" - name = "Posts" - url = "/posts/" - title = "" - weight = 1 - [[languages.en.menu.main]] - identifier = "tags" - pre = "" - post = "" - name = "Tags" - url = "/tags/" - title = "" - weight = 2 - [[languages.en.menu.main]] - identifier = "categories" - pre = "" - post = "" - name = "Categories" - url = "/categories/" - title = "" - weight = 3 - - [languages.zh-cn] - weight = 2 - title = "我的全新 Hugo 网站" - # language code, CN only here - languageCode = "zh-CN" - languageName = "简体中文" - # whether to include Chinese/Japanese/Korean - hasCJKLanguage = true - [[languages.zh-cn.menu.main]] - identifier = "posts" - pre = "" - post = "" - name = "文章" - url = "/posts/" - title = "" - weight = 1 - [[languages.zh-cn.menu.main]] - identifier = "tags" - pre = "" - post = "" - name = "标签" - url = "/tags/" - title = "" - weight = 2 - [[languages.zh-cn.menu.main]] - identifier = "categories" - pre = "" - post = "" - name = "分类" - url = "/categories/" - title = "" - weight = 3 - - [languages.fr] - weight = 3 - title = "Mon nouveau site Hugo" - languageCode = "fr" - languageName = "Français" - [[languages.fr.menu.main]] - identifier = "posts" - pre = "" - post = "" - name = "Postes" - url = "/posts/" - title = "" - weight = 1 - [[languages.fr.menu.main]] - identifier = "tags" - pre = "" - post = "" - name = "Balises" - url = "/tags/" - title = "" - weight = 2 - [[languages.fr.menu.main]] - identifier = "categories" - name = "Catégories" - pre = "" - post = "" - url = "/categories/" - title = "" - weight = 3 -``` - -Then, for each new page, append the language code to the file name. - -Single file `my-page.md` is split in three files: - -- in English: `my-page.en.md` -- in Chinese: `my-page.zh-cn.md` -- in French: `my-page.fr.md` - -{{< admonition >}} -Be aware that only translated pages are displayed in menu. It’s not replaced with default language content. -{{< /admonition >}} - -{{< admonition tip >}} -Use [Front Matter parameter](https://gohugo.io/content-management/multilingual#translate-your-content) to translate urls too. -{{< /admonition >}} - -### 4.3 Overwrite Translation Strings - -Translations strings are used for common default values used in the theme. Translations are available in [some languages](#language-compatibility), but you may use another language or want to override default values. - -To override these values, create a new file in your local i18n folder `i18n/<languageCode>.toml` and inspire yourself from `themes/CodeIT/i18n/en.toml`. - -By the way, as these translations could be used by other people, please take the time to propose a translation by [:(fas fa-code-branch fa-fw): making a PR](https://github.com/sunt-programator/CodeIT/pulls) to the theme! - -## 5 Search - -Based on [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/), searching is supported in **CodeIT** theme. - -### 5.1 Output Configuration - -In order to generate `index.json` for searching, add `JSON` output file type to the `home` of the `outputs` part in your [site configuration](#site-configuration). - -```toml -[outputs] - home = ["HTML", "RSS", "JSON"] -``` - -### 5.2 Search Configuration - -Based on `index.json` generated by Hugo, you could activate searching. - -Here is the search configuration in your [site configuration](#site-configuration): - -```toml -[params.search] - enable = true - # type of search engine ("lunr", "algolia") - type = "lunr" - # max index length of the chunked content - contentLength = 4000 - # placeholder of the search bar - placeholder = "" - # max number of results length - maxResultLength = 10 - # snippet length of the result - snippetLength = 30 - # HTML tag name of the highlight part in results - highlightTag = "em" - # whether to use the absolute URL based on the baseURL in search index - absoluteURL = false - [params.search.algolia] - index = "" - appID = "" - searchKey = "" -``` - -{{< admonition note "How to choose search engine?" >}} -The following is a comparison of two search engines: - -- `lunr`: simple, no need to synchronize `index.json`, no limit for `contentLength`, - but high bandwidth and low performance (Especially for Chinese which needs a large segmentit library) -- `algolia`: high performance and low bandwidth, but need to synchronize `index.json` and limit for `contentLength` - -The content of the post is separated by `h2` and `h3` HTML tag to improve query performance and basically implement full-text search. -`contentLength` is used to limit the max index length of the part starting with `h2` and `h3` HTML tag. -{{< /admonition >}} - -{{< admonition tip "Tips about algolia" >}} -You need to upload `index.json` files to algolia to activate searching. -You could upload the `index.json` files by browsers but a CLI tool may be better. -[Algolia Atomic](https://github.com/chrisdmacrae/atomic-algolia) is a good choice. -To be compatible with Hugo multilingual mode, -you need to upload different `index.json` for each language to the different index of algolia, such as `zh-cn/index.json` or `fr/index.json`... -{{< /admonition >}} |