Skip to content
This repository has been archived by the owner on Aug 27, 2019. It is now read-only.

Issues/147 #3

Merged
merged 2 commits into from
Jun 12, 2018
Merged

Issues/147 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bafaef
Integrated nav from SUMMARY.md
kptdobe Jun 12, 2018
b342f4d
Aligned with StrandConfig object
kptdobe Jun 12, 2018
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
14 changes: 1 addition & 13 deletions src/default.htl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,7 @@
</div>
<div class="main">
<div class="nav">
<ul>
<li>Getting Started
<ul>
<li>Release Notes</li>
<li>Videos</li>
</ul>
</li>
<li>Managing Resources</li>
<li>Publishing</li>
<li>Client-side Information</li>
<li>Administration</li>
<li>Extension Reference</li>
</ul>
<div data-sly-test="${it.nav}" data-sly-list="${it.nav}">${item}</div>
</div>
<div class="content">
<div class="content-body">
Expand Down
32 changes: 31 additions & 1 deletion src/default.pre.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const moment = require('moment');
const request = require('request-promise');
const md2json = require('md2json');

/**
* Removes the first title from the resource children
Expand All @@ -17,7 +18,9 @@ function removeFirstTitle(ctx) {
function collectMetadata(ctx) {
const options = {
uri:
ctx.strandConfig.content.api +
ctx.strandConfig.urls.content.apiRoot +
'/repos/' +
ctx.strandConfig.urls.content.repo +
'/commits?path=' +
ctx.resourcePath +
'.md',
Expand All @@ -34,6 +37,32 @@ function collectMetadata(ctx) {
});
};

/**
* Collects the nav and append it to the resource
* @param {RequestContext} ctx Context
*/
function collectNav(ctx) {
const params = {
org: ctx.strandConfig.urls.content.owner,
repo: ctx.strandConfig.urls.content.name,
tree: ctx.strandConfig.urls.content.ref,
path: 'SUMMARY.md'
};

return md2json.main(params).then(info => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kptdobe I think this is the wrong way to do it – every template script should render only one single resource and never try to go back to the repository.
You can handle this much better though an edge-side include (take a look at the nav.md example in template2lamdba, with better overall performance.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've filed adobe/project-helix#171 and #4 for this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree. Step by step... for now, that's the only way to do it.

let nav = info.body.children;
// remove first title
delete nav[0];

// link re-writing
// TODO: move into md2json + parameters
ctx.resource.nav = nav.map(element => {
return element.replace(new RegExp('href="', 'g'), 'href="/' + ctx.strand + '/');
});
return Promise.resolve(ctx);
});
};

/**
* Extracts some committers data from the list of commits and appends the list to the resource
* @param {RequestContext} ctx Context
Expand Down Expand Up @@ -80,6 +109,7 @@ module.exports.main = function (ctx) {
.then(collectMetadata)
.then(extractCommittersFromMetadata)
.then(extractLastModifiedFromMetadata)
.then(collectNav)
.catch(error => {
console.error('Error while executing default.pre.js', error);
});
Expand Down
22 changes: 18 additions & 4 deletions src/dist/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,33 @@ h1 {
color: #aaa;
}

.nav ul li ul a {
list-style: none;
color: #aaa;
}

.nav ul li.open {
.nav a {
text-decoration: none;
color: inherit;
}

.nav ul li.open, .nav ul li.open a {
list-style-image: url('data:image/svg+xml;utf8,<svg preserveAspectRatio="xMidYMid meet" height="1em" width="1em" fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" stroke="currentColor" class="_13gjrqj"><g><polyline points="6 9 12 15 18 9"></polyline></g></svg>');
}

.nav ul li.selected {
.nav ul li.selected, .nav ul li.selected a {
color: #e00;
}

.nav ul li {
.nav ul li, .nav ul li a {
padding-top: 5px;
padding-bottom: 5px;

}

.nav ul li p {
font-size: 16px;
line-height: 1.5em;
margin: 0;
}

.content {
Expand Down