Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display all pulsar api versions as list #6

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/pulsar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Pulsar API
layout: doc.ejs
includeTemplate:
- latest_pulsar_version
- pulsar_versions
---

The Pulsar API is what makes Pulsar so incredibly customizable. All packages consume it, including the packages built into the editor.
Expand Down
32 changes: 31 additions & 1 deletion helpers/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

// View helpers. Available in EJS templates via the `helpers` namespace.

const fs = require("fs");
const semver = require("semver");

module.exports = {
nextAndPreviousSidebarEntries(url, sidebar) {
let prev = null, next = null;
Expand All @@ -12,5 +14,33 @@ module.exports = {
if (index < lastIndex) next = sidebar[index + 1];
}
return [prev, next];
},

getAllPulsarVersions() {
// Returns an array of Pulsar semver versions, in order, and without 'latest'

let verArr = [];

const verDocs = fs.readdirSync("./pulsar-api/content");

for (const doc of verDocs) {
let clean = doc.replace(".json", "");

let name = clean;

if (!name.startsWith("v")) {
name = "v" + name;
}

verArr.push({
name: name,
link: clean
});
}

// Sort version array in order
verArr.sort((a, b) => { return semver.rcompare(a.name, b.name); });

return verArr;
}
};
6 changes: 0 additions & 6 deletions layouts/latest_pulsar_version.ejs

This file was deleted.

31 changes: 31 additions & 0 deletions layouts/pulsar_versions.ejs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

<%
const pulsarApiVersions = helpers.getAllPulsarVersions();
-%>

<ul class="list">

<li class="list-item">
<div class="list-item__inner">
<h3 class="list-item__name">
<a href="/api/pulsar/latest">
Latest API documentation
</a>
</h3>
</div>
</li>

<h3>All versions</h3>
<% for (const pulsarVersion of pulsarApiVersions) { %>
<li class="list-item">
<div class="list-item__inner">
<h4 class="list-item__name">
<a href="/api/pulsar/<%=pulsarVersion.link%>">
<%=pulsarVersion.name%>
</a>
</h4>
</div>
</li>
<% } %>

</ul>