mirror of
https://github.com/laurent22/joplin.git
synced 2025-03-26 21:12:59 +02:00
Doc: Added warning to generated HTML files
This commit is contained in:
Laurent Cozic
parent
5ccafa2838
commit
a9735123b7
@ -9,11 +9,11 @@ const headerHtml = `<!doctype html>
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from {{sourceMarkdownFile}} and any manual change
|
||||
This file was auto-generated from {{{sourceMarkdownFile}}} and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file: {{sourceMarkdownFile}}
|
||||
the source Markdown file:
|
||||
|
||||
!!! WARNING !!!
|
||||
https://github.com/laurent22/joplin/blob/master/{{{sourceMarkdownFile}}}
|
||||
|
||||
-->
|
||||
|
||||
@ -500,20 +500,42 @@ async function main() {
|
||||
|
||||
renderMdToHtml(makeHomePageMd(), rootDir + '/docs/index.html', {});
|
||||
|
||||
renderFileToHtml(rootDir + '/readme/changelog.md', rootDir + '/docs/changelog/index.html', { title: 'Changelog (Desktop App)' });
|
||||
renderFileToHtml(rootDir + '/readme/changelog_cli.md', rootDir + '/docs/changelog_cli/index.html', { title: 'Changelog (CLI App)' });
|
||||
renderFileToHtml(rootDir + '/readme/clipper.md', rootDir + '/docs/clipper/index.html', { title: 'Web Clipper' });
|
||||
renderFileToHtml(rootDir + '/readme/debugging.md', rootDir + '/docs/debugging/index.html', { title: 'Debugging' });
|
||||
renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', { title: 'Desktop Application' });
|
||||
renderFileToHtml(rootDir + '/readme/donate.md', rootDir + '/docs/donate/index.html', { title: 'Donate' });
|
||||
renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/e2ee/index.html', { title: 'End-To-End Encryption' });
|
||||
renderFileToHtml(rootDir + '/readme/faq.md', rootDir + '/docs/faq/index.html', { title: 'FAQ' });
|
||||
renderFileToHtml(rootDir + '/readme/mobile.md', rootDir + '/docs/mobile/index.html', { title: 'Mobile Application' });
|
||||
renderFileToHtml(rootDir + '/readme/spec.md', rootDir + '/docs/spec/index.html', { title: 'Specifications' });
|
||||
renderFileToHtml(rootDir + '/readme/stats.md', rootDir + '/docs/stats/index.html', { title: 'Statistics' });
|
||||
renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', { title: 'Terminal Application' });
|
||||
renderFileToHtml(rootDir + '/readme/api.md', rootDir + '/docs/api/index.html', { title: 'REST API' });
|
||||
renderFileToHtml(rootDir + '/readme/prereleases.md', rootDir + '/docs/prereleases/index.html', { title: 'Pre-releases' });
|
||||
const sources = [
|
||||
[ 'readme/changelog.md', 'docs/changelog/index.html', { title: 'Changelog (Desktop App)' } ],
|
||||
[ 'readme/changelog_cli.md', 'docs/changelog_cli/index.html', { title: 'Changelog (CLI App)' } ],
|
||||
[ 'readme/clipper.md', 'docs/clipper/index.html', { title: 'Web Clipper' } ],
|
||||
[ 'readme/debugging.md', 'docs/debugging/index.html', { title: 'Debugging' } ],
|
||||
[ 'readme/desktop.md', 'docs/desktop/index.html', { title: 'Desktop Application' } ],
|
||||
[ 'readme/donate.md', 'docs/donate/index.html', { title: 'Donate' } ],
|
||||
[ 'readme/e2ee.md', 'docs/e2ee/index.html', { title: 'End-To-End Encryption' } ],
|
||||
[ 'readme/faq.md', 'docs/faq/index.html', { title: 'FAQ' } ],
|
||||
[ 'readme/mobile.md', 'docs/mobile/index.html', { title: 'Mobile Application' } ],
|
||||
[ 'readme/spec.md', 'docs/spec/index.html', { title: 'Specifications' } ],
|
||||
[ 'readme/stats.md', 'docs/stats/index.html', { title: 'Statistics' } ],
|
||||
[ 'readme/terminal.md', 'docs/terminal/index.html', { title: 'Terminal Application' } ],
|
||||
[ 'readme/api.md', 'docs/api/index.html', { title: 'REST API' } ],
|
||||
[ 'readme/prereleases.md', 'docs/prereleases/index.html', { title: 'Pre-releases' } ],
|
||||
];
|
||||
|
||||
for (const source of sources) {
|
||||
source[2].sourceMarkdownFile = source[0];
|
||||
renderFileToHtml(rootDir + '/' + source[0], rootDir + '/' + source[1], source[2]);
|
||||
}
|
||||
|
||||
// renderFileToHtml(rootDir + '/readme/changelog.md', rootDir + '/docs/changelog/index.html', { title: 'Changelog (Desktop App)' });
|
||||
// renderFileToHtml(rootDir + '/readme/changelog_cli.md', rootDir + '/docs/changelog_cli/index.html', { title: 'Changelog (CLI App)' });
|
||||
// renderFileToHtml(rootDir + '/readme/clipper.md', rootDir + '/docs/clipper/index.html', { title: 'Web Clipper' });
|
||||
// renderFileToHtml(rootDir + '/readme/debugging.md', rootDir + '/docs/debugging/index.html', { title: 'Debugging' });
|
||||
// renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', { title: 'Desktop Application' });
|
||||
// renderFileToHtml(rootDir + '/readme/donate.md', rootDir + '/docs/donate/index.html', { title: 'Donate' });
|
||||
// renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/e2ee/index.html', { title: 'End-To-End Encryption' });
|
||||
// renderFileToHtml(rootDir + '/readme/faq.md', rootDir + '/docs/faq/index.html', { title: 'FAQ' });
|
||||
// renderFileToHtml(rootDir + '/readme/mobile.md', rootDir + '/docs/mobile/index.html', { title: 'Mobile Application' });
|
||||
// renderFileToHtml(rootDir + '/readme/spec.md', rootDir + '/docs/spec/index.html', { title: 'Specifications' });
|
||||
// renderFileToHtml(rootDir + '/readme/stats.md', rootDir + '/docs/stats/index.html', { title: 'Statistics' });
|
||||
// renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', { title: 'Terminal Application' });
|
||||
// renderFileToHtml(rootDir + '/readme/api.md', rootDir + '/docs/api/index.html', { title: 'REST API' });
|
||||
// renderFileToHtml(rootDir + '/readme/prereleases.md', rootDir + '/docs/prereleases/index.html', { title: 'Pre-releases' });
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/api.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/api.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>REST API | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/changelog.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/changelog.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Changelog (Desktop App) | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/changelog_cli.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/changelog_cli.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Changelog (CLI App) | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/clipper.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/clipper.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Web Clipper | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/debugging.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/debugging.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Debugging | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/desktop.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/desktop.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Desktop Application | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/donate.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/donate.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Donate | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/e2ee.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/e2ee.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>End-To-End Encryption | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/faq.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/faq.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>FAQ | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Joplin - an open source note taking and to-do application with synchronisation capabilities</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/mobile.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/mobile.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Mobile Application | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/prereleases.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/prereleases.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Pre-releases | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/spec.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/spec.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Specifications | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/stats.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/stats.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Statistics | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
|
||||
<!--
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
This file was auto-generated from readme/terminal.md and any manual change
|
||||
made to it will be overwritten. To make a change to this file please modify
|
||||
the source Markdown file:
|
||||
|
||||
https://github.com/laurent22/joplin/blob/master/readme/terminal.md
|
||||
|
||||
!!! WARNING !!!
|
||||
|
||||
-->
|
||||
|
||||
<head>
|
||||
<title>Terminal Application | Joplin</title>
|
||||
<meta charset="utf-8">
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user