diff options
author | uPagge <upagge@mail.ru> | 2020-12-06 00:26:43 +0300 |
---|---|---|
committer | uPagge <upagge@mail.ru> | 2020-12-06 00:26:43 +0300 |
commit | e7ef355f6da806520c61aa14e5ef2c8b2889052e (patch) | |
tree | e2d0a60c519bb5a65f397198df09d47371456ddf /exampleSite/content/posts/theme-documentation-basics/index.en.md | |
parent | a95d102ce8c9020594840681c2d2f5cc93e8bbc6 (diff) |
loveit -> uBlogger
Diffstat (limited to 'exampleSite/content/posts/theme-documentation-basics/index.en.md')
-rw-r--r-- | exampleSite/content/posts/theme-documentation-basics/index.en.md | 47 |
1 files changed, 23 insertions, 24 deletions
diff --git a/exampleSite/content/posts/theme-documentation-basics/index.en.md b/exampleSite/content/posts/theme-documentation-basics/index.en.md index 92285f4..6ccc540 100644 --- a/exampleSite/content/posts/theme-documentation-basics/index.en.md +++ b/exampleSite/content/posts/theme-documentation-basics/index.en.md @@ -55,26 +55,26 @@ cd my_website ### 2.2 Install the Theme -The **LoveIt** theme’s repository is: [https://github.com/dillonzq/LoveIt](https://github.com/dillonzq/LoveIt). +The **uBlogger** theme’s repository is: [https://github.com/upagge/uBlogger](https://github.com/upagge/uBlogger). -You can download the [latest release :(far fa-file-archive fa-fw): .zip file](https://github.com/dillonzq/LoveIt/releases) of the theme and extract it in the `themes` directory. +You can download the [latest release :(far fa-file-archive fa-fw): .zip file](https://github.com/upagge/uBlogger/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/dillonzq/LoveIt.git themes/LoveIt +git clone https://github.com/upagge/uBlogger.git themes/uBlogger ``` 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/dillonzq/LoveIt.git themes/LoveIt +git submodule add https://github.com/upagge/uBlogger.git themes/uBlogger ``` ### 2.3 Basic Configuration {#basic-configuration} -The following is a basic configuration for the LoveIt theme: +The following is a basic configuration for the uBlogger theme: ```toml baseURL = "http://example.org/" @@ -85,11 +85,11 @@ languageCode = "en" title = "My New Hugo Site" # Change the default theme to be use when building the site with Hugo -theme = "LoveIt" +theme = "uBlogger" [params] - # LoveIt theme version - version = "0.2.X" + # uBlogger theme version + version = "1.0.X" [menu] [[menu.main]] @@ -124,7 +124,7 @@ theme = "LoveIt" [markup] # Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting) [markup.highlight] - # false is a necessary configuration (https://github.com/dillonzq/LoveIt/issues/158) + # false is a necessary configuration noClasses = false ``` @@ -190,14 +190,14 @@ Alternatively, you can use [AWS Amplify](https://gohugo.io/hosting-and-deploymen ### 3.1 Site Configuration {#site-configuration} -In addition to [Hugo global configuration](https://gohugo.io/overview/configuration/) and [menu configuration](#basic-configuration), **LoveIt** lets you define the following parameters in your site configuration (here is a `config.toml`, whose values are default). +In addition to [Hugo global configuration](https://gohugo.io/overview/configuration/) and [menu configuration](#basic-configuration), **uBlogger** 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] - # {{< version 0.2.0 changed >}} LoveIt theme version - version = "0.2.X" + # {{< version 0.2.0 changed >}} uBlogger theme version + version = "1.0.X" # site description description = "This is My New Hugo Site" # site keywords @@ -217,7 +217,7 @@ Please open the code block below to view the complete sample configuration :(far # {{< version 0.2.0 >}} App icon config [params.app] # optional site title override for the app when added to an iOS home screen or Android launcher - title = "LoveIt" + title = "uBlogger" # whether to omit favicon resource links noFavicon = false # modern SVG favicon to use in place of older style .png and .ico files @@ -546,7 +546,7 @@ Please open the code block below to view the complete sample configuration :(far serverURLs = "" # {{< version 0.2.6 >}} emoji data file name, default is "google.yml" # ("apple.yml", "google.yml", "facebook.yml", "twitter.yml") - # located in "themes/LoveIt/assets/data/emoji/" directory + # located in "themes/uBlogger/assets/data/emoji/" directory # you can store your own data files in the same path under your project: # "assets/data/emoji/" emoji = "" @@ -658,7 +658,7 @@ Please open the code block below to view the complete sample configuration :(far [params.cdn] # CDN data file name, disabled by default # ("jsdelivr.yml") - # located in "themes/LoveIt/assets/data/cdn/" directory + # located in "themes/uBlogger/assets/data/cdn/" directory # you can store your own data files in the same path under your project: # "assets/data/cdn/" data = "" @@ -679,7 +679,6 @@ Please open the code block below to view the complete sample configuration :(far lineNos = true lineNumbersInTable = true # false is a necessary configuration - # ({{< link "https://github.com/dillonzq/LoveIt/issues/158" >}}) noClasses = false # Goldmark is from Hugo 0.60 the default library used for Markdown [markup.goldmark] @@ -769,7 +768,7 @@ You could enable these features with `hugo serve -e production`. data = "" ```` -The default CDN data file is located in `themes/LoveIt/assets/data/cdn/` directory. +The default CDN data file is located in `themes/uBlogger/assets/data/cdn/` directory. You can store your own data file in the same path under your project: `assets/data/cdn/`. {{< /admonition >}} @@ -800,7 +799,7 @@ Or You can set more options through a dict: title = "Mastodon" ``` -The default data of all supported social links is located in `themes/LoveIt/assets/data/social.yaml`, +The default data of all supported social links is located in `themes/uBlogger/assets/data/social.yaml`, which is you can refer to. {{< /admonition >}} @@ -829,11 +828,11 @@ Customize `browserconfig.xml` and `site.webmanifest` to set theme-color and back Hugo **extended** version is necessary for the style customization. {{< /admonition >}} -**LoveIt** theme has been built to be as configurable as possible by defining custom `.scss` style files. +**uBlogger** 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/LoveIt/assets/css/_variables.scss` to customize the style. +In `assets/css/_override.scss`, you can override the variables in `themes/uBlogger/assets/css/_variables.scss` to customize the style. Here is a example: @@ -846,7 +845,7 @@ In `assets/css/_custom.scss`, you can add some css style code to customize the s ## 4 Multilingual and i18n -**LoveIt** theme is fully compatible with Hugo multilingual mode, which provides in-browser language switching. +**uBlogger** theme is fully compatible with Hugo multilingual mode, which provides in-browser language switching. ![Language Switch](language-switch.gif "Language Switch") @@ -995,15 +994,15 @@ Use [Front Matter parameter](https://gohugo.io/content-management/multilingual#t 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/LoveIt/i18n/en.toml`. +To override these values, create a new file in your local i18n folder `i18n/<languageCode>.toml` and inspire yourself from `themes/uBlogger/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/dillonzq/LoveIt/pulls) to the theme! +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/upagge/uBlogger/pulls) to the theme! ## 5 Search {{< version 0.2.0 >}} -Based on [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/), searching is supported in **LoveIt** theme. +Based on [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/), searching is supported in **uBlogger** theme. ### 5.1 Output Configuration |