Commit 2a6fa3b8 authored by Jurgen van den Brink's avatar Jurgen van den Brink

[WIP] Refactoring website

parent 18a8e82e
Pipeline #33148984 passed with stage
in 1 minute and 52 seconds
......@@ -28,3 +28,20 @@ bundle exec jekyll build
Make sure you set the following environment variable: `JEKYLL_ENV=production`
The website is generated in the folder `./public`.
## Section/page variables
The following variables are supported in the header of a page or section:
- `title`: Title of the page or section;
- `name`: Name of the page or section in the menu;
- `bookmark`: Bookmark (`#`) of the page or section;
- `source`: Specifies the path to the source of the file;
- `code`: Example code displayed on the right;
- `indent`: Specifies if the section is indented in the navigation;
- `endpoint`: Specigies the type of endpoint, can be `put`, `delete`, `get` or `post`.
And the following variables are only available for pages:
- `base`: Specifies the relative path to the base;
- `permalink`: Specifies the path of the page itself;
- `custom`: Specifies if the page should not be rendered as a section;
- `heading`: Specifies the heading (alternate title) for pages;
- `sitemap`: Specifies if a page should be included in the sitemap (defaults to `true`).
source: src
destination: public
email: support@tripetto.com
description: "Documentation for Tripetto"
url: "https://docs.tripetto.community"
repository: "https://gitlab.com/tripetto/docs/blob/master/src/"
permalink: pretty
accounts:
twitter: tripetto
gitlab: tripetto
github: tripetto
gitter: tripetto
npm_packages:
editor: "tripetto"
collector: "tripetto-collector"
google_tag_manager: GTM-W5BFLGF
webmaster_verifications:
google: GpD9B8bbinfS8C12pO_zBUn3Smu5UKhUuk2YwZUsYco
collections_dir: docs
collections:
docs_index:
permalink: /
name: Getting started
position: 0
docs_editor:
permalink: /editor/
name: Editor
position: 1
docs_collector:
permalink: /collector/
name: Collector
position: 2
docs_blocks:
permalink: /blocks/
name: Blocks
position: 3
docs_support:
permalink: /support/
name: Support
position: 4
docs_sdk:
permalink: /sdk/
name: SDK
position: 5
plugins:
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-minifier
defaults:
- scope:
path: ""
values:
layout: docs
kramdown:
auto_ids: false
source: src
destination: public
email: support@tripetto.com
description: "Documentation for Tripetto"
url: "https://docs.tripetto.community"
repository: "https://gitlab.com/tripetto/docs/blob/master/src/"
permalink: pretty
accounts:
twitter: tripetto
gitlab: tripetto
github: tripetto
gitter: tripetto
npm_packages:
editor: "tripetto"
collector: "tripetto-collector"
google_tag_manager: GTM-W5BFLGF
webmaster_verifications:
google: GpD9B8bbinfS8C12pO_zBUn3Smu5UKhUuk2YwZUsYco
collections_dir: sections
collections:
- api_functional
- api_l10n
- api_module_num
- guide_collector
- guide_editor
- guide_blocks
- quickstart
plugins:
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-minifier
defaults:
- scope:
path: ""
values:
layout: default
kramdown:
auto_ids: false
---
---
#### Signature
##### **buttonType**: *void*
{: .signature }
#### Description
Retrieves or specifies the type.
Types:
- `normal`
- `accept`
- `warning`
- `cancel`
---
---
#### Signature
##### **buttonType**: *void*
{: .signature }
#### Description
Retrieves or specifies the type.
Types:
- `normal`
- `accept`
- `warning`
- `cancel`