Skip to content
GitLab

Switch to Hugo

Merged XhmikosR requested to merge v4-dev-xmr-hugo-2 into master

TODO:

  • make sure our folder structure is the proper one for what we want to achieve. Also see if we can make folders nesting level smaller, maybe by using permalinks or something. For content and static.
  • Review the new Chroma styles
  • audit the changes by bep or someone familiar with Hugo

TODO (can be sorted out maybe after the merge)

  • can we generate SRI hashes for existent files on the fly? For bootstrap.min.css, bootstrap.min.js, bootstrap.bundle.min.js, popper.js/1.14.7/umd/popper.min.js. This would simplify things as we could remove the release-sri script
  • get image width/height with Hugo when possible (examples images, homepage)
  • maybe use Hugo Extended version for docs' CSS?
  • bep's suggestion:

    Re.

    {{< partial "callout-warning-color-assistive-technologies.md" >}}

    The partial above uses the partial func to load, parse and execute templates. This has its limitations and is possibly ineffective. I would recommend that you store your callouts (and other content files you want to include) in a so-called headless bundle -- and load them via .GetPage. This way you can use markdown + shortcodes etc.

  • bep's suggestion:

    Ref. {{ block "header" . }} in your single.html template. Blocks only make sense inside base template(s) (i.e. baseof.html), which I cannot see. I would highly recommend that you restructure your templates to use them. It removes some repetition.

Fixed issues
  • fix Netlify previews; fixed with the relative URLs
  • make sure all layouts are fine
    • homepage
      • Fix variables in code snippets
    • examples
      • index page
      • individual examples are not being generated at all
    • versions
      • sort versions in reverse
      • fix 4.0 showing up as 4; fixed by using strings in data files
  • fix partial include/icons
  • fix docs sidebar menu; see if we can still use a data file for this
    • fix single menu item (Migrate)
  • placeholder shortcode: backport the latest v4-dev changes
  • Fix bugify
  • Example shortcode
    • remove the placeholder SVG etc
    • Fix nested placeholder like in media object second example; the regex is too overzealous. We might need to split the string like we currently do.
    • remove the extra newline when there's a placeholder image
    • add default lang html for example shortcode; it seems we only pass HTML
    • support hide_markup or nohighlight in example shortcode and adapt content
    • Use false for text and title in the example shortcode instead of " "
  • fix ToC styling
  • whitespace control
  • Streamline the inline shortcodes whitespace
  • make sure the HTML comments we really want to keep are kept
  • Fix the remaining inline HTML content cases
  • Regenerate Chroma/Pygments styles and adapt it
  • Report/Work around the stray p tags issue
  • Figure out/report why https://github.com/twbs/bootstrap/pull/28014/files#diff-cadd93f34018d2674cc31bd8da855e07R352 isn't rendered as HTML
  • compare the number of generated pages so that we don't have extra/missing ones like /docs/index.html
  • Before the merge:
    • Remove --renderToDisk from docs-serve script
    • Remove any temp commits

Fixes #24475 (closed)

Preview: https://deploy-preview-28014--twbs-bootstrap.netlify.com/