LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

Merge pull request #272 from lbryio/api-refresh

Browse source 
Updates to the SDK documentation
This commit is contained in:
netop:// ウェッブ 2019-04-12 15:38:55 -04:00 committed by GitHub
commit 11f0e33a8a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 126 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
app/components/feature-links.js
View file

@ -51,7 +51,9 @@ export default () => {
let imageLink = "";
for (const link of links) {
if (link.image) imageLink = `<img alt="${link.title}" src="${link.image}"/>`;
if (link.image)
imageLink = `<img alt="${link.title}" src="${link.image}"/>`;
renderedLinks.push(returnLinkTemplate(link.href, link.title, imageLink));
}

4
app/components/glossary-toc.js
View file

@ -50,6 +50,8 @@ function slugify(stringToSlugify) {
.replace(/\)/g, "")
.replace(/,/g, "");
if (finalString.match(numberRegex)) finalString = `_${finalString}`;
if (finalString.match(numberRegex))
finalString = `_${finalString}`;
return `#${finalString}`;
}

13
app/components/head.js
View file

@ -16,10 +16,17 @@ import config from "@root/config";
export default (state, emit) => {
const newMetadata = state.lbry;
const description = newMetadata && newMetadata.description ? newMetadata.description : config.meta.description;
const title = newMetadata && newMetadata.title ? newMetadata.title + " - lbry.tech" : "lbry.tech - " + config.meta.tagline;
const description = newMetadata && newMetadata.description ?
newMetadata.description :
config.meta.description;
const title = newMetadata && newMetadata.title ?
newMetadata.title + " - lbry.tech" :
"lbry.tech - " + config.meta.tagline;
if (state.title !== title)
emit(state.events.DOMTITLECHANGE, title);
if (state.title !== title) emit(state.events.DOMTITLECHANGE, title);
state.page = state.page || { };
return html`

12
app/dist/scripts/api.js vendored
View file

@ -1,10 +1,14 @@
"use strict"; /* global document, Jets */
"use strict"; /* global document, Jets, window */
// Initiate search functionality
const contentTag = window.location.pathname.split("/").pop() === "sdk" ?
".api-toc__section" :
"#toc";
let jets = new Jets({
contentTag: "#toc",
contentTag,
searchTag: "#input-search"
});
@ -15,7 +19,6 @@ document.getElementById("input-search").value = "";
document.getElementById("input-search").addEventListener("keyup", () => {
if (document.getElementById("input-search").value)
document.querySelector(".api-toc__search-clear").classList.add("active");
else
document.querySelector(".api-toc__search-clear").classList.remove("active");
});
@ -24,6 +27,7 @@ document.getElementById("input-search").addEventListener("keyup", () => {
document.querySelector(".api-toc__search-clear").addEventListener("click", () => {
document.getElementById("input-search").value = "";
document.querySelector(".api-toc__search-clear").classList.remove("active");
jets.destroy();
reinitJets();
});
@ -55,7 +59,7 @@ function handleApiLanguageToggles(language) {
function reinitJets() {
jets = new Jets({
contentTag: "#toc",
contentTag,
searchTag: "#input-search"
});

13
app/sass/pages/_api.scss
View file

@ -77,7 +77,14 @@
}
}
.api-toc__items {
.api-toc__title {
padding: 0.25rem 0.5rem 0.25rem 0.75rem;
opacity: 0.3;
pointer-events: none;
text-transform: uppercase;
}
.api-toc__commands {
font-size: 0.8rem;
line-height: 1.33;
list-style-type: none;
@ -85,7 +92,7 @@
padding-bottom: 1rem;
}
.api-toc__item {
.api-toc__command {
&:hover {
background-color: $lbry-gray-2;
}
@ -215,6 +222,8 @@
}
.api-content__body-argument {
display: flex;
&:not(:last-of-type) {
border-bottom: 1px solid $lbry-gray-2;
}

98
app/views/api.js
View file

@ -16,9 +16,7 @@ import redirects from "@data/redirects.json";
const blockchainApi = "https://cdn.jsdelivr.net/gh/lbryio/lbrycrd@master/contrib/devtools/generated/api_v1.json";
const cache = new Map();
const sdkApi = process.env.NODE_ENV === "development" ?
"https://cdn.jsdelivr.net/gh/lbryio/lbry@generate_examples/docs/api.json" : // TODO: Remove when `generate_examples` is merged into master
"https://cdn.jsdelivr.net/gh/lbryio/lbry@master/docs/api.json";
const sdkApi = "https://cdn.jsdelivr.net/gh/lbryio/lbry@api_doc_categories/docs/api.json";
@ -26,7 +24,9 @@ const sdkApi = process.env.NODE_ENV === "development" ?
export default async(state) => {
// below is evil, I just inherited it -- Jeremy
const apilabel = state.params.wildcard == "sdk" ? "SDK" : state.params.wildcard.charAt(0).toLocaleUpperCase() + state.params.wildcard.substring(1);
const apilabel = state.params.wildcard === "sdk" ?
"SDK" :
state.params.wildcard.charAt(0).toLocaleUpperCase() + state.params.wildcard.substring(1);
state.lbry = {
title: apilabel + " API Documentation",
@ -45,7 +45,9 @@ export default async(state) => {
<ul class="api-toc__search-results"></ul>
</div>
<ul class="api-toc__items" id="toc" role="navigation">${createApiSidebar(apiResponse)}</ul>
<ul class="api-toc__commands" id="toc" role="navigation">
${apilabel === "SDK" ? createSdkSidebar(apiResponse) : createApiSidebar(apiResponse)}
</ul>
</aside>
<section class="api-content">
<div class="api-documentation" id="toc-content">
@ -57,7 +59,7 @@ export default async(state) => {
</nav>
${createApiHeader(state.params.wildcard)}
${createApiContent(apiResponse)}
${apilabel === "SDK" ? createSdkContent(apiResponse) : createApiContent(apiResponse)}
</div>
</section>
</div>
@ -150,7 +152,7 @@ function createApiSidebar(apiDetails) {
for (const apiDetail of apiDetails) {
apiSidebar.push(`
<li class="api-toc__item">
<li class="api-toc__command">
<a href="#${apiDetail.name}" title="Go to ${apiDetail.name} section">
${apiDetail.name}
</a>
@ -161,6 +163,69 @@ function createApiSidebar(apiDetails) {
return apiSidebar;
}
function createSdkContent(apiDetails) {
const apiContent = [];
const sectionTitles = Object.keys(apiDetails);
for (const title of sectionTitles) {
const commands = apiDetails[title].commands;
const description = apiDetails[title].doc;
apiContent.push(
commands.length ?
commands.map(command => createSdkContentSections(title, description, command)).join("") :
""
);
}
return apiContent;
}
function createSdkContentSections(sectionTitle, sectionDescription, sectionDetails) {
/*
<h2 id="${sectionTitle}">${sectionTitle}</h2>
<p>${sectionDescription}</p>
<hr/>
*/
return `
<div class="api-content__body">
<h2 id="${sectionDetails.name}">${sectionDetails.name}</h2>
<p>${sectionDetails.description}</p>
<h3>Arguments</h3>
<ul class="api-content__body-arguments">
${renderArguments(sectionDetails.arguments).join("")}
</ul>
<h3>Returns</h3>
<pre><code>${renderReturns(sectionDetails.returns)}</code></pre>
</div>
<div class="api-content__example">
${renderExamples(sectionDetails.examples).join("")}
</div>
`;
}
function createSdkSidebar(apiDetails) {
const sectionTitles = Object.keys(apiDetails);
const apiSidebar = [];
for (const title of sectionTitles) {
const commands = apiDetails[title].commands;
apiSidebar.push(`
<ul class="api-toc__section">
<li class="api-toc__title">${title}</li>
${(commands.map(command => `<li class="api-toc__command"><a href="#${command.name}" title="Go to ${command.name} section">${command.name}</a></li>`)).join("")}
</ul>
`);
}
return apiSidebar;
}
async function parseApiFile(urlSlug) {
let apiFileLink;
@ -192,6 +257,9 @@ async function parseApiFile(urlSlug) {
function renderArguments(args) {
const argumentContent = [];
if (!args || args.length === 0)
return argumentContent;
for (const arg of args) {
argumentContent.push(`
<li class="api-content__body-argument">
@ -211,6 +279,11 @@ function renderArguments(args) {
function renderExamples(args) {
const exampleContent = [];
if (!args || args.length === 0) {
exampleContent.push("<pre><code>// example(s) to come later</code></pre>");
return exampleContent;
}
for (const arg of args) {
exampleContent.push(`
<h3>${arg.title}</h3><br/>
@ -220,8 +293,19 @@ function renderExamples(args) {
<h3>Output</h3><br/>
<pre><code>${arg.output}</code></pre>
<hr/>
`);
}
return exampleContent;
}
function renderReturns(args) {
let returnContent = [];
if (!args || args.length === 0)
return returnContent;
returnContent = dedent(JSON.parse(JSON.stringify(args)));
return returnContent;
}