Renders a section wrapped in an <article> tag with optional <header>. Markdown from that section will be yielded as the body of the article.

• class:

  (optional) Adds class to <article>

• style:

  (optional) Adds style to <article>

• anchor:

  (optional) if set, an anchor will be created at the begining of the <article>

• title:

  (optional) will be used by some external widget in conjuction with anchor

Renders a section wrapped in an <article> tag with optional <header>. Markdown from that section will be yielded as the body of the article.

• class:

  (optional) Adds class to <article>

• style:

  (optional) Adds style to <article>

• title:

  (optional) Will be rendered as <header>

• title_tag:

  (defaults to h2) which tag to wrap the title with inside <header>

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

Renders a hero section wrapped in a <hero> tag. The background image will pull the image from the section if use_image is set to True oterwise, Calico will try to use background.

Most text will be rendered inside of an <hgroup> tag.

If cta is present, it will be rendered as a link after the <hgroup> tag.

Markdown from that section will be yielded at the end of the <hgroup> tag.

• image:

  (optional) Path to the image to use if use_image is True. This will always be used inside a <col> tag inside the <hero> if present.

• svg:

  (optional) if svg is provided instead of img, calico will try to include the widget named in this property (ex: svg.gitlab)

• background:

  (optional) Path to the image to use if use_image is False

• style:

  (optional) Adds style to <article>

• use_image:

  (defaults to False) Whether to use image or background as background image.

• use_title:

  (defaults to False) Whether to use the title of the section inside an <h1> tag inside of <hgroup>.

• use_subtitle:

  (defaults to False) Whether to use the subtitle of the section after the <h1> tag inside of <hgroup>. Is only useful if use_title is True.

• title:

  (optional) Will be rendered as <h1> inside of <hgroup> if use_title is True

• subtitle:

  (optional) Will be rendered after <h1> inside of <hgroup> if use_title and use_subtitle are both True

• cta:

  (optional) Call to action object. Rendered as an <a> tag after <hgroup>

  • class: (defaults to 'btn btn-primary btn-lg px-4 me-md-2') the class to apply to the cta <a> tag
  • link: (defaults to '#') cta link
  • text: cta text

A button to switch between light and dark mode

Markdown links are always opened in a new tab.

If you'd like to have links that open in the current tab (ie: for internal links), use this widget inline within your markdown

<cc‐link with text="my text" link="/link/to/page.html" />

• text:

  link text

• link:

  link url

No documentation found

Main navigation menu.

• logo:

  (optional) path to the image to display as logo in the navigation

• home_text:

  (optional) alt text (or just text if not logo) to display as first item of the manu

• list_anchors:

  (default: False) if True the menu will list links to all the anchors in the current page

• include_light_switch:

  (default: False) if True the menu will include a button to switch between light and dark mode

• extra_links:

  (optional) a list of extra items to be shown in the menu

  • title: Text for the link
  • url: Url for the link

Section widgets are represented as a <section> block inside which their content is rendered.

Additionally, sections can have "sub-widgets" passed as a list of items. Each item points to a file relative to the original section file. This is useful to represent things like grids.

• class:

  (optional) The class(es) to apply to the section

• style:

  (optional) The style(s) to apply to the section

• items:

  (optional) a list of markdown files without the extention, usually hidden (starting with _). Those will be rendered inside the section.

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

No documentation found

This widget allows to create links over embedded SVGs.

<cc‐svglink with title="my text" link="/link/to/page.html" svg="svg.sun" />

• link:

  link url

• svg:

  svg widget to embed

• title:

  (optional) title text (show on hover)

• class:

  (default svglink) class applied on the <a> tag

• style:

  (default '') style applied on the <a> tag

Renders a section wrapped in an <article> tag with optional <header>. Markdown from that section will be yielded as the body of the article.

• class:

  (optional) Adds class to <article>

• style:

  (optional) Adds style to <article>

• image:

  (optional) Path to the image to prefix the body of the article with

• image_class:

  (optional) class to applyt to the image

• title:

  (optional) Will be rendered as <header>

• title_tag:

  (defaults to h2) which tag to wrap the title with inside <header>

The widget used to render this page