bryan
/
BangleApps
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

App description can now be markdown

master
Gordon Williams 2020-05-28 14:34:40 +01:00
parent 0c0fc9ac8f
commit ab5861126c
3 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -19,3 +19,4 @@ Changed for individual apps are listed in `apps/appname/ChangeLog`
* If `bin/pre-publish.sh` has been run and recent.csv created, add 'Sort By' chip * If `bin/pre-publish.sh` has been run and recent.csv created, add 'Sort By' chip
* New 'espruinotools' which fixes pretokenise issue when ID follows ID (fix #416) * New 'espruinotools' which fixes pretokenise issue when ID follows ID (fix #416)
* Improve upload of binary files * Improve upload of binary files
* App description can now be markdown

2
README.md
View File

@ -217,7 +217,7 @@ and which gives information about the app for the Launcher.
"name": "Readable name", // readable name "name": "Readable name", // readable name
"shortName": "Short name", // short name for launcher "shortName": "Short name", // short name for launcher
"icon": "icon.png", // icon in apps/ "icon": "icon.png", // icon in apps/
"description": "...", // long description "description": "...", // long description (can contain markdown)
"type":"...", // optional(if app) - 'app'/'widget'/'launch'/'bootloader' "type":"...", // optional(if app) - 'app'/'widget'/'launch'/'bootloader'
"tags": "", // comma separated tag list for searching "tags": "", // comma separated tag list for searching

9
js/index.js
View File

@ -52,6 +52,11 @@ function showReadme(appid) {
} }
httpGet(appPath+app.readme).then(show).catch(()=>show("Failed to load README.")); httpGet(appPath+app.readme).then(show).catch(()=>show("Failed to load README."));
} }
function getAppDescription(app) {
let appPath = `apps/${app.id}/`;
let markedOptions = { baseUrl : appPath };
return marked(app.description, markedOptions);
}
function handleCustomApp(appTemplate) { function handleCustomApp(appTemplate) {
// Pops up an IFRAME that allows an app to be customised // Pops up an IFRAME that allows an app to be customised
if (!appTemplate.custom) throw new Error("App doesn't have custom HTML"); if (!appTemplate.custom) throw new Error("App doesn't have custom HTML");
@ -259,7 +264,7 @@ function refreshLibrary() {
</div> </div>
<div class="tile-content"> <div class="tile-content">
<p class="tile-title text-bold">${escapeHtml(app.name)} ${versionInfo}</p> <p class="tile-title text-bold">${escapeHtml(app.name)} ${versionInfo}</p>
<p class="tile-subtitle">${escapeHtml(app.description)}${app.readme?`<br/>${readme}`:""}</p> <p class="tile-subtitle">${getAppDescription(app)}${app.readme?`<br/>${readme}`:""}</p>
<a href="${url}" target="_blank" class="link-github"><img src="img/github-icon-sml.png" alt="See the code on GitHub"/></a> <a href="${url}" target="_blank" class="link-github"><img src="img/github-icon-sml.png" alt="See the code on GitHub"/></a>
</div> </div>
<div class="tile-action"> <div class="tile-action">
@ -470,7 +475,7 @@ function refreshMyApps() {
</div> </div>
<div class="tile-content"> <div class="tile-content">
<p class="tile-title text-bold">${escapeHtml(app.name)} <small>(${version.text})</small></p> <p class="tile-title text-bold">${escapeHtml(app.name)} <small>(${version.text})</small></p>
<p class="tile-subtitle">${escapeHtml(app.description)}</p> <p class="tile-subtitle">${getAppDescription(app)}</p>
<a href="${url}" target="_blank" class="link-github"><img src="img/github-icon-sml.png" alt="See the code on GitHub"/></a> <a href="${url}" target="_blank" class="link-github"><img src="img/github-icon-sml.png" alt="See the code on GitHub"/></a>
</div> </div>
<div class="tile-action"> <div class="tile-action">