1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00
joplin/Tools/build-website.js

396 lines
10 KiB
JavaScript
Raw Normal View History

const fs = require('fs-extra');
const dirname = require('path').dirname;
const marked = require('marked');
const Mustache = require('mustache');
2017-07-31 21:47:58 +02:00
2017-11-18 01:07:04 +02:00
const headerHtml = `<!doctype html>
2017-07-31 21:47:58 +02:00
<html>
<head>
2017-11-18 00:12:30 +02:00
<title>Joplin - an open source note taking and to-do application with synchronisation capabilities</title>
2017-07-31 21:47:58 +02:00
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
2018-03-29 21:42:11 +02:00
<link rel="stylesheet" href="https://joplin.cozic.net/css/bootstrap.min.css">
2017-07-31 22:09:47 +02:00
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
2018-03-29 21:48:22 +02:00
<link rel="stylesheet" href="https://joplin.cozic.net/css/fontawesome-all.min.css">
2018-03-29 21:42:11 +02:00
<script src="https://joplin.cozic.net/js/jquery-3.2.1.slim.min.js"></script>
2017-07-31 21:47:58 +02:00
<style>
body {
background-color: #F1F1F1;
color: #333333;
}
2017-10-31 00:58:41 +02:00
table {
margin-bottom: 1em;
}
2017-10-31 00:59:46 +02:00
td, th {
2017-11-18 00:12:30 +02:00
padding: .8em;
border: 1px solid #ccc;
2017-10-31 00:58:41 +02:00
}
2017-10-31 01:16:45 +02:00
h1, h2 {
2017-10-31 01:13:55 +02:00
border-bottom: 1px solid #eaecef;
padding-bottom: 0.3em;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-weight: 600;
font-size: 2em;
2017-10-31 01:19:49 +02:00
margin-bottom: 16px;
2017-10-31 01:13:55 +02:00
}
2017-10-31 01:16:45 +02:00
h2 {
font-size: 1.6em;
}
2017-10-31 01:19:49 +02:00
h3 {
font-size: 1.3em;
}
2017-10-31 02:02:34 +02:00
code {
color: black;
background-color: #eee;
border: 1px solid #ccc;
2018-02-17 01:14:26 +02:00
font-size: .85em;
2017-10-31 02:02:34 +02:00
}
pre code {
border: none;
}
2018-02-17 01:14:26 +02:00
pre {
font-size: .85em;
}
2018-03-29 21:17:11 +02:00
#toc ul {
margin-bottom: 10px;
}
#toc {
padding-bottom: 1em;
}
2017-07-31 21:47:58 +02:00
.title-icon {
height: 2em;
}
.sub-title {
font-weight: bold;
font-size: 1.5em;
}
.container {
background-color: white;
padding: 0;
box-shadow: 0 10px 20px #888888;
}
table.screenshots {
margin-top: 2em;
margin-bottom: 2em;
}
table.screenshots th {
height: 3em;
text-align: center;
}
table.screenshots th,
table.screenshots td {
border: 1px solid #C2C2C2;
}
2018-03-20 19:36:07 +02:00
img[align="left"] {
margin-right: 10px;
margin-bottom: 10px;
}
2017-07-31 21:47:58 +02:00
.mobile-screenshot {
height: 40em;
padding: 1em;
}
.cli-screenshot-wrapper {
background-color: black;
vertical-align: top;
padding: 1em 2em 1em 1em;
}
.cli-screenshot {
font-family: "Monaco", "Inconsolata", "CONSOLAS", "Deja Vu Sans Mono", "Droid Sans Mono", "Andale Mono", monospace;
background-color: black;
color: white;
border: none;
}
.cli-screenshot .prompt {
color: #48C2F0;
}
.top-screenshot {
margin-top: 2em;
text-align: center;
}
2017-07-31 21:47:58 +02:00
.header {
position: relative;
padding-left: 2em;
padding-right: 2em;
padding-top: 1em;
padding-bottom: 1em;
color: white;
background-color: #2B2B3D;
}
2018-03-31 20:19:11 +02:00
.header a h1 {
color: white;
}
2017-07-31 21:47:58 +02:00
.content {
padding-left: 2em;
padding-right: 2em;
padding-bottom: 2em;
2017-10-31 00:47:36 +02:00
padding-top: 2em;
2017-07-31 21:47:58 +02:00
}
.forkme {
position: absolute;
right: 0;
top:0;
}
2017-11-18 01:07:04 +02:00
.nav-wrapper {
position: relative;
width: inherit;
}
2017-11-18 00:12:30 +02:00
.nav {
background-color: black;
2017-11-18 01:07:04 +02:00
display: table;
width: inherit;
}
.nav.sticky {
position:fixed;
top: 0;
width: inherit;
2017-11-18 01:17:16 +02:00
box-shadow: 0 0 10px #000000;
2017-11-18 00:12:30 +02:00
}
.nav a {
color: white;
2017-11-18 00:15:54 +02:00
display: inline-block;
2017-11-18 19:35:49 +02:00
padding: .6em .9em .6em .9em;
2017-11-18 01:07:04 +02:00
}
2017-11-18 00:12:30 +02:00
.nav ul {
padding-left: 2em;
margin-bottom: 0;
2017-11-18 01:07:04 +02:00
display: table-cell;
2018-04-28 11:40:27 +02:00
min-width: 250px;
2017-11-18 00:12:30 +02:00
}
.nav ul li {
display: inline-block;
2017-11-18 00:15:54 +02:00
padding: 0;
2017-11-18 00:12:30 +02:00
}
.nav li.selected {
background-color: #222;
font-weight: bold;
}
2017-11-18 01:07:04 +02:00
.nav-right {
display: table-cell;
width: 100%;
text-align: right;
vertical-align: middle;
line-height: 0;
}
.nav-right .share-btn {
display: none;
}
.nav-right .small-share-btn {
display: none;
2017-11-18 01:09:57 +02:00
}
2018-03-29 21:17:11 +02:00
.footer {
padding-top: 1em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
font-size: .9em;
}
@media all and (min-width: 400px) {
.nav-right .share-btn {
display: inline-block;
}
.nav-right .small-share-btn {
display: none;
}
}
</style>
2017-07-31 21:47:58 +02:00
</head>
<body>
<div class="container">
<div class="header">
2017-11-18 00:12:30 +02:00
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="{{{imageBaseUrl}}}/ForkMe.png"/></a>
2018-03-31 20:19:11 +02:00
<a href="https://joplin.cozic.net"><h1 id="joplin"><img class="title-icon" src="{{{imageBaseUrl}}}/Icon512.png">oplin</h1></a>
2017-11-18 00:12:30 +02:00
<p class="sub-title">An open source note taking and to-do application with synchronisation capabilities.</p>
</div>
2017-11-18 01:07:04 +02:00
<div class="nav-wrapper">
<div class="nav">
<ul>
2017-11-18 19:35:49 +02:00
<li class="{{selectedHome}}"><a href="{{baseUrl}}/" title="Home"><i class="fa fa-home"></i></a></li>
2018-04-28 11:40:27 +02:00
<li><a href="https://discourse.joplin.cozic.net" title="Forum">Forum</a></li>
2018-04-25 19:24:13 +02:00
<li><a class="help" href="#" title="Menu">Menu</a></li>
2017-11-18 01:07:04 +02:00
</ul>
<div class="nav-right">
<iframe class="share-btn" src="https://www.facebook.com/plugins/share_button.php?href=http%3A%2F%2Fjoplin.cozic.net&layout=button&size=small&mobile_iframe=true&width=60&height=20&appId" width="60" height="20" style="border:none;overflow:hidden" scrolling="no" frameborder="0" allowTransparency="true"></iframe>
<iframe class="share-btn" src="https://platform.twitter.com/widgets/tweet_button.html?url=http%3A%2F%2Fjoplin.cozic.net" width="62" height="20" title="Tweet" style="border: 0; overflow: hidden;"></iframe>
2017-12-04 19:55:06 +02:00
<iframe class="share-btn share-btn-github" src="https://ghbtns.com/github-btn.html?user=laurent22&repo=joplin&type=star&count=true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
2017-11-18 01:07:04 +02:00
</div>
</div>
2017-07-31 21:47:58 +02:00
</div>
<div class="content">
2018-03-29 21:17:11 +02:00
{{{tocHtml}}}
2017-07-31 21:47:58 +02:00
`;
const footerHtml = `
2018-03-29 21:17:11 +02:00
<div class="footer">
Copyright (c) 2016-2018 Laurent Cozic
</div>
2017-07-31 21:47:58 +02:00
</body>
</html>
`;
2017-10-31 00:43:11 +02:00
// const screenshotHtml = `
// <table class="screenshots">
// <tr>
// <th>
// Mobile
// </th>
// <th>
// Command line
// </th>
// </tr>
// <tr>
// <td>
// <img class="mobile-screenshot" src="docs/images/Mobile.png"/>
// </td>
// <td class="cli-screenshot-wrapper">
// <pre class="cli-screenshot">
// <span class="prompt">joplin:/My notebook$</span> ls -n 12
// [ ] 8am conference call ☎
// [ ] Make vet appointment
// [ ] Go pick up parcel
// [ ] Pay flat rent 💸
// [X] Book ferry 🚢
// [X] Deploy Joplin app
// Open source stuff
// Swimming pool time table 🏊
// Grocery shopping list 📝
// Work itinerary
// Tuesday random note
2017-11-17 20:57:27 +02:00
// Vacation plans ☀
2017-10-31 00:43:11 +02:00
// </pre>
// </td>
// </tr>
// </table>
// `;
2017-07-31 21:47:58 +02:00
2017-11-18 01:07:04 +02:00
const scriptHtml = `
2017-07-31 22:15:04 +02:00
<script>
2017-11-18 01:07:04 +02:00
function stickyHeader() {
2018-03-29 21:17:11 +02:00
return; // Disabled
2017-11-18 01:07:04 +02:00
if ($(window).scrollTop() > 179) {
$('.nav').addClass('sticky');
} else {
$('.nav').removeClass('sticky');
}
}
2017-07-31 22:15:04 +02:00
2018-03-29 21:17:11 +02:00
$('#toc').hide();
$('.help').click(function(event) {
event.preventDefault();
$('#toc').show();
});
2017-11-18 01:07:04 +02:00
$(window).scroll(function() {
stickyHeader();
});
2017-07-31 22:15:04 +02:00
2017-11-18 01:07:04 +02:00
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-103586105-1', 'auto');
ga('send', 'pageview');
2017-07-31 22:15:04 +02:00
</script>
`;
2017-12-04 19:55:06 +02:00
const rootDir = dirname(__dirname);
2017-07-31 21:47:58 +02:00
function markdownToHtml(md) {
const renderer = new marked.Renderer();
let output = marked(md, {
gfm: true,
break: true,
renderer: renderer,
});
2017-11-18 01:07:04 +02:00
return headerHtml + output + scriptHtml + footerHtml;
2017-07-31 21:47:58 +02:00
}
2018-03-29 21:17:11 +02:00
let tocMd_ = null;
let tocHtml_ = null;
const tocRegex_ = /<!-- TOC -->([^]*)<!-- TOC -->/
function tocMd() {
if (tocMd_) return tocMd_;
const md = fs.readFileSync(rootDir + '/README.md', 'utf8');
const toc = md.match(tocRegex_);
tocMd_ = toc[1];
return tocMd_;
}
function tocHtml() {
if (tocHtml_) return tocHtml_;
const MarkdownIt = require('markdown-it');
const markdownIt = new MarkdownIt();
let md = tocMd();
md = md.replace(/# Table of contents/, '');
md = md.replace(/https:\/\/github.com\/laurent22\/joplin\/blob\/master\/readme\/(.*)\.md/g, 'https://joplin.cozic.net/$1');
tocHtml_ = markdownIt.render(md);
tocHtml_ = '<div id="toc">' + tocHtml_ + '</div>';
return tocHtml_;
}
function renderMdToHtml(md, targetPath, params) {
2018-03-31 20:19:11 +02:00
// Remove the header because it's going to be added back as HTML
md = md.replace(/# Joplin\n/, '');
2018-03-24 22:13:52 +02:00
params.baseUrl = 'https://joplin.cozic.net';
params.imageBaseUrl = params.baseUrl + '/images';
2018-03-29 21:17:11 +02:00
params.tocHtml = tocHtml();
2017-11-18 00:12:30 +02:00
const html = Mustache.render(markdownToHtml(md), params);
fs.writeFileSync(targetPath, html);
}
2018-03-29 21:17:11 +02:00
function renderFileToHtml(sourcePath, targetPath, params) {
const md = fs.readFileSync(sourcePath, 'utf8');
return renderMdToHtml(md, targetPath, params);
}
function makeHomePageMd() {
let md = fs.readFileSync(rootDir + '/README.md', 'utf8');
md = md.replace(tocRegex_, '');
return md;
}
2017-07-31 21:47:58 +02:00
async function main() {
2018-03-29 21:17:11 +02:00
tocMd();
2017-07-31 21:47:58 +02:00
2018-03-29 21:17:11 +02:00
// renderFileToHtml(rootDir + '/README.md', rootDir + '/docs/index.html', {
// selectedHome: 'selected',
// });
2017-11-18 18:13:27 +02:00
2018-03-29 21:17:11 +02:00
// renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', {
// selectedTerminal: 'selected',
// });
// renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', {
// selectedDesktop: 'selected',
// });
// let readmeMd = fs.readFileSync(rootDir + '/README.md', 'utf8');
renderMdToHtml(makeHomePageMd(), rootDir + '/docs/index.html', {});
2018-03-29 21:17:11 +02:00
// renderFileToHtml(rootDir + '/README.md', rootDir + '/docs/index.html', {});
renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', {});
2018-04-04 21:48:42 +02:00
renderFileToHtml(rootDir + '/readme/debugging.md', rootDir + '/docs/debugging/index.html', {});
2018-03-29 21:17:11 +02:00
renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', {});
2018-04-25 19:24:13 +02:00
renderFileToHtml(rootDir + '/readme/faq.md', rootDir + '/docs/faq/index.html', {});
2018-03-29 21:17:11 +02:00
renderFileToHtml(rootDir + '/readme/mobile.md', rootDir + '/docs/mobile/index.html', {});
2018-03-29 01:52:27 +02:00
renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/e2ee/index.html', {});
renderFileToHtml(rootDir + '/readme/spec.md', rootDir + '/docs/spec/index.html', {});
renderFileToHtml(rootDir + '/readme/stats.md', rootDir + '/docs/stats/index.html', {});
renderFileToHtml(rootDir + '/readme/changelog.md', rootDir + '/docs/changelog/index.html', {});
renderFileToHtml(rootDir + '/readme/donate.md', rootDir + '/docs/donate/index.html', {});
2017-07-31 21:47:58 +02:00
}
main().catch((error) => {
2017-07-31 21:47:58 +02:00
console.error(error);
});