eclipsefdn-hugo-solstice-theme 0.0.182 → 0.0.184

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,29 +3,31 @@ Title: Eclipse Foundation Projects Page
3
3
  hide_sidebar: true
4
4
  ---
5
5
 
6
- Using the **eclipsefdn_projects** shortcode in order to generate a list of projects that is pulled from the projects.eclipse.org API.
6
+ The **`eclipsefdn_projects`** shortcode renders a working group's projects. They
7
+ can be filtered by category or search.
7
8
 
8
- ## Parameters:
9
+ ## Parameters
9
10
 
10
- - **templateId:** string | The mustache template to use
11
- - **url:** string | Url of the PMI endpoint to be using
12
- - **classes:** string | Classes for the block
13
- - **display_categories:** bool | true or false
14
- - **categories:** string | Path to the json file containing the projects categories
11
+ | Name | Type | Description |
12
+ | -------------------- | --------------- | --------------------------------------------------------------------------------- |
13
+ | `templateId` | `string \| nil` | The mustache template to use. |
14
+ | `url` | `string` | URL of the PMI endpoint to use. |
15
+ | `types` | `string \| nil` | Types of projects to display. Accepts the following: `"projects"`, `"proposals"`. |
16
+ | `classes` | `string \| nil` | Classes for the block. |
17
+ | `display_categories` | `bool` | Toggle the display of category filters. |
18
+ | `categories` | `string \| nil` | Path to the JSON file containing project categories. |
19
+ | `is_static_source` | `bool \| nil` | If projects are from an endpoint other than the PMI, set this to `true`. |
15
20
 
21
+ ## Examples
16
22
 
17
- ## Examples:
23
+ Following list of projects has been filtered to display "Jakarta EE" projects:
18
24
 
19
- Following list of projects has been filtered to display "Cloud Development Tools" projects:
20
-
21
- {{< eclipsefdn_projects
22
- templateId="tpl-projects-item"
23
- url="https://projects.eclipse.org/api/projects?working_group=cloud-development-tools"
24
- classes="margin-top-30"
25
- display_categories="true"
25
+ {{< eclipsefdn_projects templateId="tpl-projects-item"
26
+ url="https://projects.eclipse.org/api/projects?working_group=jakarta-ee"
27
+ classes="margin-top-30" display_categories="true"
26
28
  categories="/js/featured-projects-categories.json"
27
29
  >}}
28
30
 
29
31
  {{< grid/div isMarkdown="false" >}}
30
32
  <script type="text/javascript" src="/js/eclipsefdn.projects.js"></script>
31
- {{</ grid/div >}}
33
+ {{</ grid/div >}}
@@ -14,6 +14,7 @@
14
14
  {{ $templateId := .Get "templateId" }}
15
15
  {{ $projectIds := .Get "projectIds" }}
16
16
  {{ $url := .Get "url" | relURL }}
17
+ {{ $types := .Get "types" | default "projects, proposals" }}
17
18
  {{ $is_static_source := .Get "is_static_source" | default "false" }}
18
19
  {{ $classes := .Get "classes" }}
19
20
  {{ $display_categories := .Get "display_categories" | default "false" }}
@@ -31,10 +32,12 @@
31
32
  {{ end }}
32
33
  <ul class="featured-projects list-inline list {{ $classes }}"
33
34
  id="{{ $id }}"
35
+ data-types="{{ $types }}"
34
36
  data-project-ids="{{ $projectIds }}"
35
37
  data-template-id="{{ $templateId }}"
36
38
  data-url="{{ $url }}"
37
39
  data-is-static-source="{{ $is_static_source }}"></ul>
40
+
38
41
  </div>
39
42
  </div>
40
43
  {{ if eq $display_view_more "true" }}
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "main": "webpack.min.js",
5
5
  "author": "Christopher Guindon",
6
6
  "license": "EPL-2.0",
7
- "version": "0.0.182",
7
+ "version": "0.0.184",
8
8
  "bugs": {
9
9
  "url": "https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-solstice-theme/-/issues"
10
10
  },
@@ -23,7 +23,7 @@
23
23
  "readmeFilename": "README.md",
24
24
  "dependencies": {
25
25
  "axios": "^0.21.1",
26
- "eclipsefdn-solstice-assets": "0.0.216",
26
+ "eclipsefdn-solstice-assets": "0.0.221",
27
27
  "json2yaml": "^1.1.0",
28
28
  "toml": "^3.0.0"
29
29
  },