Documentación del Tema - Conceptos Básicos

Descubre como es el tema FixIt para Hugo y los conceptos fundamentales del mismo.

1 Requisitos

Gracias a la simplicidad de Hugo, el propio Hugo es lo único necesario para usar este tema.

Basta con instalar la última versión  Hugo (> 0.62.0) para tu SO (Windows, Linux, macOS).

¿Por qué no hay soporte para las versiones antiguas de Hugo?
Puesto que el Markdown Render Hooks se introdujo en la versión Hugo Christmas Edition, este tema sólo funciona con versiones de Hugo posteriores a la 0.62.0.
Se recomienda la versión extendida de Hugo (Hugo extended)
Dado que algunas funcionalidades de este tema necesitan convertir  SCSS en  CSS, se recomienda usar la versión Hugo extended para disponer de toda la funcionalidad.

2 Instalación

Sigue los siguientes pasos para iniciar tu nuevo sitio web. Si aún no sabes nada de Hugo, te sugerimos encarecidamente que aprendas más de el siguiendo esta estupenda documentación para principiantes.

2.1 Crea tu proyecto

Hugo facilita el comando new para crear un nuevo sitio web:

1
2
hugo new site my_website
cd my_website

2.2 Instala el tema

El repositorio del tema FixIt es: https://github.com/Lruihao/FixIt.

Puedes descargar la última versión  .zip file del tema y extraerla en el directorio themes.

Alternativamente, puedes clonar el repositorio en el directorio themes.

1
git clone https://github.com/Lruihao/FixIt.git themes/FixIt

O, crear un repositorio git vacío y añadir el tema como un submodulo:

1
2
git init
git submodule add https://github.com/Lruihao/FixIt.git themes/FixIt

2.3 Configuración Básica

A continuación puedes ver un ejemplo de la configuración básica para el tema LoveIt:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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 = "FixIt"

[params]
  # FixIt 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/Lruihao/FixIt/issues/43)
    noClasses = false
Nota
  • Cuando construyas un sitio web con Hugo, puedes establecer el tema con la opción --theme. Sin embargo, te sugerimos modificar el fichero de configuración (config.toml) y establecer el tema por defecto.
  • FixIt NUEVO | 0.2.14 El tema FixIt soporta submenues. Echa un ojo a la sección Menu Advanced Configuration.

2.4 Crea tu primera entrada

Esta es la forma de invocar Hugo para crear tu primera entrada:

1
hugo new posts/first_post.md

Edita la entrada (post) añadiendo algún contenido de ejemplo y reemplazando el valor del título al comienzo del fichero.

Nota
Por defecto todas las entradas y páginas se crean como borrador (draft). Si quieres que Hugo genere esas páginas hay tres opciones: eliminar la propiedad draft: true de los metadatos del documento, establecer la propiedad como draft: false o añadir la opción -D/--buildDrafts cuando invocamos a hugo.

2.5 Arrancando el sitio web localmente

Puedes arrancar el sito web localmente con el siguiente comando:

1
hugo server

Go to http://localhost:1313.

/theme-documentation-basics/basic-configuration-preview.png
Vsita previa de la Configuración Básica

Consejo
Mientras ejecutas hugo serve, cuando los contenidos de los ficheros cambian las páginas web se refrescan automáticamente para reflejar los cambios.
Nota

Puesto que el tema usa .Scratch en Hugo para implementar algunas funcionalidades es muy recomendable añadir la opción --disableFastRender al comando hugo server para generar la vista previa de las páginas localmente mientras editamos.

1
hugo serve --disableFastRender

2.6 Generar el sitio web

Cuando tengas todo listo para desplegar tu sitio web ejecuta el siguiente comando:

1
hugo

Se generará un directorio public con todo el contenido estático y los contenidos auxiliares necesarios para tu sitio web. Este contenido puede desplegarse en cualquier servidor web.

Consejo

El sito web puede alojarse y publicarse automáticamente con Netlify (Más información Automated HUGO deployments with Netlify).

Alternativamente puedes usar AWS Amplify, Github pages, Render y más …

3 Configuración

3.1 Configuración del Site

Además de la Configuración Global de Hugo y la configuración de menu, el tema FixIt te permite definir los siguientes parámetros en la configuración de tu sitio web (aquí tienes un fichero config.toml, con los parámetros y sus valores por defecto).

Despliega el bloque de código a continuación para ver la configuración de ejemplo completa :

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
[params]
  # FixIt MODIFICADO | 0.2.0 FixIt 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 = ""
  # FixIt NUEVO | 0.1.1 which hash function used for SRI, when empty, no SRI is used
  # ("sha256", "sha384", "sha512", "md5")
  fingerprint = ""
  # FixIt NUEVO | 0.2.0 date format
  dateFormat = "2006-01-02"
  # website images for Open Graph and Twitter Cards
  images = ["/logo.png"]
  # FixIt NUEVO | 0.2.12 enable PWA
  enablePWA = true
  # FixIt NUEVO | 0.2.14 whether to add external Icon for external links automatically
  externalIcon = false

  # FixIt NUEVO | 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 = "FixIt"
    # whether to omit favicon resource links
    noFavicon = false
    # modern SVG favicon to use in place of older style .png and .ico files
    svgFavicon = ""
    # Safari mask icon color
    iconColor = "#5bbad5"
    # Windows v8-10 tile color
    tileColor = "#da532c"
    # FixIt MODIFICADO | 0.2.12 Android browser theme color
    [params.app.themeColor]
      light = "#ffffff"
      dark = "#252627"

  # FixIt NUEVO | 0.2.0 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 = ""
    # FixIt NUEVO | 0.2.1 max number of results length
    maxResultLength = 10
    # FixIt NUEVO | 0.2.3 snippet length of the result
    snippetLength = 30
    # FixIt NUEVO | 0.2.1 HTML tag name of the highlight part in results
    highlightTag = "em"
    # FixIt NUEVO | 0.2.4 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 ("sticky", "normal", "auto")
    desktopMode = "sticky"
    # mobile header mode ("sticky", "normal", "auto")
    mobileMode = "auto"
    # FixIt NUEVO | 0.2.0 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 = ""
      # FixIt NUEVO | 0.2.5 whether to use typeit animation for title name
      typeit = false

  # Footer config
  [params.footer]
    enable = true
    # FixIt NUEVO | 0.2.0 Custom content (HTML format is supported)
    custom = ''
    # FixIt NUEVO | 0.2.0 whether to show Hugo and theme info
    hugo = true
    # FixIt NUEVO | 0.2.0 whether to show copyright info
    copyright = true
    # FixIt NUEVO | 0.2.0 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>'

  # FixIt NUEVO | 0.2.0 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
    # FixIt NUEVO | 0.2.13 recently updated posts settings
    [params.section.recentlyUpdated]
      enable = false
      rss = false
      days = 30
      maxCount = 10

  # FixIt NUEVO | 0.2.0 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]
    # FixIt NUEVO | 0.2.0 amount of RSS pages
    rss = 10
    # Home page profile
    [params.home.profile]
      enable = true
      # FixIt NUEVO | 0.2.13 Gravatar mirror site domain, default: "www.gravatar.com"
      gravatarSite = ""
      # Gravatar Email for preferred avatar in home page
      gravatarEmail = ""
      # URL of avatar shown in home page
      avatarURL = "/images/avatar.png"
      # FixIt MODIFICADO | 0.2.7 title shown in home page (HTML format is supported)
      title = ""
      # subtitle shown in home page
      subtitle = "This is My New Hugo Site"
      # whether to use typeit animation for subtitle
      typeit = true
      # whether to show social links
      social = true
      # FixIt NUEVO | 0.2.0 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

  # 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 = ""
    # ORCID, ... , CSDN FixIt NUEVO | 0.2.13
    ORCID = ""
    Liberapay = ""
    Ko-Fi = ""
    BuyMeaCoffee = ""
    Linktree = ""
    QQ = ""
    QQGroup = ""
    Diaspora = ""
    CSDN = ""
    Email = "xxxx@xxxx.com"
    RSS = true # FixIt NUEVO | 0.2.0

  # FixIt MODIFICADO | 0.2.0 Page config
  [params.page]
    # FixIt NUEVO | 0.2.0 whether to hide a page from home page
    hiddenFromHomePage = false
    # FixIt NUEVO | 0.2.0 whether to hide a page from search results
    hiddenFromSearch = false
    # FixIt NUEVO | 0.2.0 whether to enable twemoji
    twemoji = false
    # whether to enable lightgallery
    lightgallery = false
    # FixIt NUEVO | 0.2.0 whether to enable the ruby extended syntax
    ruby = true
    # FixIt NUEVO | 0.2.0 whether to enable the fraction extended syntax
    fraction = true
    # FixIt NUEVO | 0.2.0 whether to enable the fontawesome extended syntax
    fontawesome = true
    # 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>'
    # whether to show link to Raw Markdown content of the content
    linkToMarkdown = true
    # FixIt NUEVO | 0.2.4 whether to show the full text content in RSS
    rssFullText = false
    # FixIt NUEVO | 0.2.13 Page style ("narrow", "normal", "wide", ...)
    pageStyle = "normal"
    # FixIt NUEVO | 0.2.0 Table of the contents config
    [params.page.toc]
      # whether to enable the table of the contents
      enable = true
      # FixIt NUEVO | 0.2.9 whether to keep the static table of the contents in front of the post
      keepStatic = false
      # whether to make the table of the contents in the sidebar automatically collapsed
      auto = true
      # FixIt NUEVO | 0.2.13 position of TOC ("left", "right")
      position = "right"
    # FixIt NUEVO | 0.2.13 Display a message at the beginning of an article to warn the reader that its content might be expired
    [params.page.expirationReminder]
      enable = false
      # Display the reminder if the last modified time is more than 90 days ago
      reminder = 90
      # Display warning if the last modified time is more than 180 days ago
      warning = 180
      # If the article expires, close the comment or not
      closeComment = false
    # FixIt MODIFICADO | 0.2.0 KaTeX mathematical formulas (https://katex.org)
    [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
    # FixIt NUEVO | 0.2.0 Code config
    [params.page.code]
      # whether to show the copy button of the code block
      copy = true
      # FixIt NUEVO | 0.2.13 whether to show the edit button of the code block
      edit = true
      # the maximum number of lines of displayed code by default
      maxShownLines = 10
    # FixIt NUEVO | 0.2.14 Post edit
    [params.page.edit]
      enable = false
      # url = "https://github.com/user-name/repo-name/edit/branch-name/subdirectory-name" # Link for fork & edit
      url = "https://github.com/Lruihao/FixIt/edit/master/exampleSite/content" # Link for fork & edit
    # FixIt NUEVO | 0.2.0 Mapbox GL JS config (https://docs.mapbox.com/mapbox-gl-js)
    [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 NavigationControl
      navigation = true
      # whether to add GeolocateControl
      geolocate = true
      # whether to add ScaleControl
      scale = true
      # whether to add FullscreenControl
      fullscreen = true
    # FixIt MODIFICADO | 0.2.0 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
    # FixIt MODIFICADO | 0.2.13 Comment config
    [params.page.comment]
      enable = false
      # FixIt NUEVO | 0.2.13 Artalk comment config (https://artalk.js.org/)
      [params.page.comment.artalk]
        enable = false
        server = "https://yourdomain/api/"
        site = "默认站点"
        placeholder = ""
        noComment = ""
        sendBtn = ""
        editorTravel = true
        flatMode = 'auto'
        maxNesting = 3
        # It take effect when `params.page.lightgallery` is enabled
        lightgallery = false
      # Disqus comment config (https://disqus.com)
      [params.page.comment.disqus]
        # FixIt NUEVO | 0.1.1
        enable = false
        # Disqus shortname to use Disqus in posts
        shortname = ""
      # Gitalk comment config (https://github.com/gitalk/gitalk)
      [params.page.comment.gitalk]
        # FixIt NUEVO | 0.1.1
        enable = false
        owner = ""
        repo = ""
        clientId = ""
        clientSecret = ""
      # Valine comment config (https://github.com/xCss/Valine)
      [params.page.comment.valine]
        enable = false
        appId = ""
        appKey = ""
        placeholder = ""
        avatar = "mp"
        meta= ""
        pageSize = 10
        lang = ""
        visitor = true
        recordIP = true
        highlight = true
        enableQQ = false
        serverURLs = ""
        # FixIt NUEVO | 0.2.6 emoji data file name, default is "google.yml"
        # ("apple.yml", "google.yml", "facebook.yml", "twitter.yml")
        # located in "themes/FixIt/assets/data/emoji/" directory
        # you can store your own data files in the same path under your project:
        # "assets/data/emoji/"
        emoji = ""
        commentCount = true # FixIt NUEVO | 0.2.13
      # FixIt NUEVO | 0.2.13 Waline comment config (https://waline.js.org)
      [params.page.comment.waline]
        enable = false
        serverURL = ""
        visitor = false
        emoji = ['https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo']
        meta = ['nick', 'mail', 'link']
        requiredMeta = []
        login = 'enable'
        wordLimit = 0
        pageSize = 10
        uploadImage = false
        highlight = true
        mathTagSupport = false
        commentCount = false
      # Facebook comment config (https://developers.facebook.com/docs/plugins/comments)
      [params.page.comment.facebook]
        enable = false
        width = "100%"
        numPosts = 10
        appId = ""
        languageCode = ""
      # FixIt NUEVO | 0.2.0 Telegram comments config (https://comments.app)
      [params.page.comment.telegram]
        enable = false
        siteID = ""
        limit = 5
        height = ""
        color = ""
        colorful = true
        dislikes = false
        outlined = false
      # FixIt NUEVO | 0.2.0 Commento comment config (https://commento.io)
      [params.page.comment.commento]
        enable = false
      # FixIt NUEVO | 0.2.5 Utterances comment config (https://utteranc.es)
      [params.page.comment.utterances]
        enable = false
        # owner/repo
        repo = ""
        issueTerm = "pathname"
        label = ""
        lightTheme = "github-light"
        darkTheme = "github-dark"
      # FixIt NUEVO | 0.2.13 Twikoo comment config (https://twikoo.js.org/)
      [params.page.comment.twikoo]
        enable = false
        envId = ""
        region = ""
        path = ""
        visitor = true
        commentCount = true
        # It take effect when `params.page.lightgallery` is enabled
        lightgallery = false
    # FixIt NUEVO | 0.2.7 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"
    # FixIt MODIFICADO | 0.2.10 Page SEO config
    [params.page.seo]
      # image URL
      images = []
      # Publisher info
      [params.page.seo.publisher]
        name = ""
        logoUrl = ""

  # FixIt NUEVO | 0.2.5 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

  # FixIt NUEVO | 0.2.12 Watermark config
  # Detail config see https://github.com/Lruihao/watermark#readme
  [params.watermark]
    enable = false
    # watermark's text (HTML format is supported)
    content = ''
    # watermark's transparency
    opacity = 0.1
    # parent of watermark's container
    appendTo = '.wrapper>main'
    # watermark's width. unit: px
    width = 150
    # watermark's height. unit: px
    height = 20
    # row spacing of watermarks. unit: px
    rowSpacing = 60
    # col spacing of watermarks. unit: px
    colSpacing = 30
    # watermark's tangent angle. unit: deg
    rotate = 15
    # watermark's fontSize. unit: rem
    fontSize = 0.85
    # watermark's fontFamily
    fontFamily = 'inherit'

  # FixIt NUEVO | 0.2.12 Busuanzi count
  [params.ibruce]
    enable = true
    # Enable in post meta
    enablePost = false
    # Site creation time e.g. '2019-02-03T19:30:34+08:00'
    siteTime = ''

  # Site verification code config for Google/Bing/Yandex/Pinterest/Baidu/360/Sogou
  [params.verification]
    google = ""
    bing = ""
    yandex = ""
    pinterest = ""
    baidu = ""
    so = ""
    sogou = ""

  # FixIt NUEVO | 0.2.10 Site SEO config
  [params.seo]
    # image URL
    image = ""
    # thumbnail URL
    thumbnailUrl = ""

  # FixIt NUEVO | 0.2.0 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 = ""

  # FixIt NUEVO | 0.2.7 Cookie consent config
  [params.cookieconsent]
    enable = true
    # text strings used for Cookie consent banner
    [params.cookieconsent.content]
      message = ""
      dismiss = ""
      link = ""

  # FixIt MODIFICADO | 0.2.7 CDN config for third-party library files
  [params.cdn]
    # CDN data file name, disabled by default
    # ("jsdelivr.yml")
    # located in "themes/FixIt/assets/data/cdn/" directory
    # you can store your own data files in the same path under your project:
    # "assets/data/cdn/"
    data = ""

  # FixIt NUEVO | 0.2.8 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

  # FixIt NUEVO | 0.2.12 Custom JS at last
  # "_custom.js" located in "themes/FixIt/assets/js/"
  # you can store your custom JS file in the same path under your project:
  # "assets/js/_custom.js"
  [params.customJS]
    enable = true
  # FixIt NUEVO | 0.2.14 GitHub banner in the top-right corner
  [params.githubCorner]
    enable = false
    permalink = "https://github.com/Lruihao/FixIt"
    title = "View source on GitHub"

# Markup related configuration in Hugo
[markup]
  # Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting)
  [markup.highlight]
    ########## necessary configurations ##########
    # https://github.com/Lruihao/FixIt/issues/43
    codeFences = true
    lineNos = true
    lineNumbersInTable = true
    noClasses = false
    ########## necessary configurations ##########
    guessSyntax = true
  # 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

# Permalinks config (https://gohugo.io/content-management/urls#permalinks)
[Permalinks]
  # posts = ":year/:month/:filename"
  posts = ":filename"

# Privacy config (https://gohugo.io/about/hugo-and-gdpr/)
[privacy]
  [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]
  # FixIt MODIFICADO | 0.2.0
  home = ["HTML", "RSS", "JSON"]
  page = ["HTML", "MarkDown"]
  section = ["HTML", "RSS"]
  taxonomy = ["HTML", "RSS"]
  taxonomyTerm = ["HTML"]
Nota
Algunos de estos parámetros se explican con mas detalle en otras secciones de esta docuementación.
Hugo environments

Los entornos (enviroments) por defecto son development, que se usa con hugo server y production que se usa con hugo.

Debido a limitaciones del entorno local development, el comment system (sistema de comentarios), y el CDN junto con el fingerprint no estarán habilitados en este entorno development.

Siempre puede habilitar estas funcionalidad añadiendo la opción hugo serve -e production al invocar a Hugo.

Ayuda para la configuración de CDN

FixIt MODIFICADO | 0.2.7

1
2
3
4
[params.cdn]
  # CDN data file name, disabled by default
  # ("jsdelivr.yml")
  data = ""

El fichero de datos por defecto para CDN se localiza en el directorio themes/FixIt/assets/data/cdn/.

Puedes guardar tu propio fichero en el mismo path de tu proyecto: assets/data/cdn/.

Ayudas para la configuración de datos sociales

FixIt NUEVO | 0.2.0

Puedes establecer tu ID directamente para tener un enlace a la red social y su icono:

1
2
[params.social]
  Mastodon = "@xxxx"

El enlace a la red social generado será https://mastodon.technology/@xxxx.

También puedes pasar más opciones como un dict:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[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"

Los datos por defecto para todas las redes sociales soportadas están localizados en themes/FixIt/assets/data/social.yaml, puedes consultarlo como referencia.

/theme-documentation-basics/complete-configuration-preview.png
Vista previa de la configuración completa

3.2 Favicons, Browserconfig, Manifest

Es recomendable que configures tus propios 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)

dentro del directorio /static. Puedes crearlos fácilmente via https://realfavicongenerator.net/.

Edita los ficheros browserconfig.xml y site.webmanifest para establecer tus preferencias para el theme-color y el background-color.

3.3 Style Customization

FixIt MODIFICADO | 0.2.8
Nota
Es imprescindible usar la versión Hugo extended para poder hacer adaptaciones de estilo (style).

El tema FixIt se ha implementado para ser tan configurable como sea posible definiendo ficheros de estilo .scss a tu medida.

El directorio donde residen los ficheros de estilo .scss es assets/css relativo al directorio raiz de tu proyecto.

En el fichero assets/css/_override.scss, puedes redefinir las variables de themes/LoveIt/assets/css/_variables.scss para adaptar el estilo a tu gusto.

Aquí tienes un ejemplo:

1
2
@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;

En el fichero assets/css/_custom.scss, puedes añadir códigos css para adaptar aún más tus estilos.

3.3.1 Page Style

FixIt NUEVO | 0.2.13

The FixIt theme provides a page width configuration option pageStyle and three values.

  • narrow Keep <v0.2.13 page/toc width ratio
  • normal New default page/toc width ratio
  • wide Larger page/toc width ratio

In addition, you can also customize the pageStyle value in assets/css/_custom.scss

For example: pageStyle="custom"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
@media only screen and (min-width: 1441px) {
  [page-style='custom'] {
    .page {
      width: 70%;
    }

    aside {
      width: 15%;
    }
  }
}

@media only screen and (max-width: 1440px) {
  [page-style='custom'] {
    .page {
      width: 60%;
    }

    aside {
      width: 20%;
    }
  }
}

@media only screen and (max-width: 1200px) {
  [page-style='custom'] {
    .page {
      width: 56%;
    }

    aside {
      width: 22%;
    }
  }
}
FixIt NUEVO | 0.2.13

There are three css common class for print view in FixIt Theme.

  • page-break-before Insert page break before element
  • page-break-after Insert page break after element
  • print-d-none Hide elements in print view

Here is a simple exmple:

1
2
3
4
5
<div class="page-break-before"></div>
<div class="page-break-after"></div>
<div class="print-d-none">
  Something you want to hide in the print view is written here.
</div>

Hugo has a simple yet powerful menu system.

According to the interface provided by Hugo, FixIt theme only realizes some functions, but I think it is enough to meet the needs of most people and make users easier to use.

The following is a complete menu item configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[menu]
  [[menu.main]]
    identifier = "posts"
    # FixIt NUEVO | 0.2.14 Identifier of the parent menu item
    parent = ""
    # 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
    # FixIt NUEVO | 0.2.14 add user-defined content to menu items
    [menu.main.params]
      # add css class to a specific menu item
      class = 'text-center'
      # whether set as a draft menu item whose function is similar to a draft post/page
      draft = false

3.4.1 Sub Menu

FixIt NUEVO | 0.2.14

In consideration of practicability and typesetting, the FixIt theme only supports two-tier nested menus, which can be configured through the parent field in the menu configuration.

The parent item of a menu item should be the identifier of another menu item, and the identifier should be unique in the menu.

3.4.2 Menu Params

FixIt NUEVO | 0.2.14

You can also add user-defined content to menu items via the params field. The FixIt theme currently provides two parameters:

  • class {String} add css class to a specific menu item
  • draft {Boolean} whether set as a draft menu item whose function is similar to a draft post/page
Nota
The draft menu items and posts/pages can be rendered by starting the Hugo server command or adding the -D/--buildDrafts parameter to hugo command.
Consejo

This helps to distinguish the different contents of preview environment and production environment during deployment.

For example:

3.4.3 Add content to Menu

It’s also possible to create menu entries from the page by configuring front matter (i.e. the .md-file).

Here is a yaml example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
---
title: "Theme Documentation - Basics"
author: "Lruihao"
menu:
  main:
    name: "Basics"
    title: "Discover what the Hugo - FixIt theme is all about and the core-concepts behind it."
    parent: "documentation"
    pre: "<i class='fab fa-readme fa-fw fa-sm'></i>"
---
...

4 Soporte Multilingüe e i18n

El tema LoveIt es totalmente compatible con el modo Multilingüe de Hugo, que implementa la elección de idioma en el navegador.

/theme-documentation-basics/language-switch.gif
Cambio de Idioma

4.1 Compatibilidad

FixIt MODIFICADO | 0.2.10
Language Hugo Code HTML lang Attribute Theme Docs Lunr.js Support
English en en
Simplified Chinese zh-cn zh-CN
French fr fr
Polish pl pl
Brazilian Portuguese pt-br pt-BR
Italian it it
Spanish es es
German de de
Serbian sr sr
Russian ru ru
Romanian ro ro
Vietnamese vi vi
Traditional Chinese zh-tw zh-TW

4.2 Configuración Básica

Despues de aprenderte como Hugo gestiona websites multilingües, puedes definir tus idiomas en la configuración de tu sitio web.

Por ejemplo para un website con Inglés, Chino y Francés:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# [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

Una vez configurados los idiomas, para cada nueva página, añade el código de idioma al nombre del fichero.

Por ejemplo la página my-page.md se tendría que implementar en tres ficheros:

  • en Inglés: my-page.en.md
  • en Chino: my-page.zh-cn.md
  • en Francés: my-page.fr.md
Nota
Ten en cuenta que sólo las páginas traducidas se muestran en los menús. No hay ningún mecanismo para reemplazarlas con un idioma por defecto.
Consejo
Puedes usar los Parámetros del Front Matter para traducir también las urls.

4.3 Sobre-escribir las cadenas de Traducción

Las cadenas de traducción (Translations strings) implementan la traducción de los mensajes frecuentes o mensajes por defecto usados en el tema. Las traducciones están disponibles para algunos idiomas, pero puedes usar otro idioma o sobre-escribir los valores por defecto de un idioma.

Para sobre-escribir esos valores, crea un nuevo fichero en tu directorio local i18n i18n/<languageCode>.toml puedes basarte en el fichero themes/LoveIt/i18n/en.toml para crear tu versión en un nuevo idioma.

Por cierto, como estas traducciones podrían ser usadas por otra gente, por favor considera invertir parte de tu tiempo en proponer una traducción  haciendo un Pull Request en el repo del tema.

5 Búsqueda

FixIt NUEVO | 0.2.0

La busqueda está soportada en el tema FixIt, puede estar basada en Lunr.js o en algolia.

5.1 Configuración de la salida

Para poder generar el fichero index.json necesario para la busqueda, hay que añadir JSON a los tipos de fichero de salida para el home en la sección de outputs en tu fichero de configuración del sitio.

1
2
[outputs]
  home = ["HTML", "RSS", "JSON"]

5.2 Configuración de la búsqueda

Puedes activar la opción de búsqueda basada en el fichero index.json generado por Hugo.

Aquí puedes ver la configuración de la búsqueda en el fichero site configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
[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 = ""
  # FixIt NUEVO | 0.2.1 max number of results length
  maxResultLength = 10
  # FixIt NUEVO | 0.2.3 snippet length of the result
  snippetLength = 30
  # FixIt NUEVO | 0.2.1 HTML tag name of the highlight part in results
  highlightTag = "em"
  # FixIt NUEVO | 0.2.4 whether to use the absolute URL based on the baseURL in search index
  absoluteURL = false
  [params.search.algolia]
    index = ""
    appID = ""
    searchKey = ""
¿Qué motor de búsqueda escoger?

A continuación tienes una comparativa entre los dos motores de búsqueda:

  • lunr: simple, no hay necesidad de sincronizar el fichero index.json, no hay limites para el contentLength, pero necesitarás un ancho de banda mayor y tendrás un rendimiento menor (Especialmente para el Chino que necesita una gran biblioteca de segmentos)
  • algolia: Alto rendimiento y bajo ancho de banda, pero necesitaras sincronizar el fichero index.json y limitar el contentLength

FixIt NUEVO | 0.2.3 El contenido de una entrada se separa con cabeceras HTML h2 yh3 para mejorar el rendimiento de las consultas y emplementar una búsqueda de texto completo.

Se usa contentLength para limitar la longitud máxima del indexado de las partes que comienzan con etiquetas HTML h2 y h3.

Ayudas para algolia

Es necesario añadir los ficheros index.json a algolia para activar la búsqueda.

Podrías subir los ficheros index.json mediante el navegador pero es más conveniente usar alguna herramienta CLI. Una buena elección podría ser Algolia Atomic

Para mantener la compatibilidad con el modo multi-idioma de Hugo, es necesario subir a algolia diferentes ficheros index.json para cada uno de los idiomas, por ejemplo: zh-cn/index.json or fr/index.json


Gracias
Gracias al autor original Dillon por preparar y revisar todo el contenido previo a la versión v0.2.10 de este documento.