upagge/noteshare.space
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 💬 Update static pages

Browse Source
This commit is contained in:
Maxime Cannoodt 2022-08-17 10:39:02 +02:00
parent 7ea11903f8
commit 14e4b37418
5 changed files with 50 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
webapp/src/routes/__layout.svelte
View File

@ -38,7 +38,7 @@
<div class="top-0 left-0 right-0">
<NavBar>
<svelte:fragment slot="left">
<NavBarLink href="/about">How it works</NavBarLink>
<NavBarLink href="/about">About</NavBarLink>
<NavBarLink href="/install">Get plugin</NavBarLink>
<NavBarLink href="/contact">Contact</NavBarLink>
</svelte:fragment>

31
webapp/src/routes/about.svelte
View File

@ -18,35 +18,12 @@
<h2>How it works</h2>
<p>
The encryption mechanism is based on services such as Firefox Send. The basic operation is as
follows:
I have written a <a href="https://mcndt.dev/posts/how-to-e2e-encryption/">detailed blog post</a>
about how this service works. You can read it if you want to know more.
</p>
<ol>
<li>
The Obsidian plugin encrypts your note with AES-256-CBC, using a cryptographically secure,
single-use key.
</li>
<li>
The encrypted note is sent to the server for storage. The decryption key never leaves your
device. The server will store your note for 31 days.
</li>
<li>
The decryption key is added to the share link using a hash symbol: <code
>https://noteshare.space/note/[NOTE_ID]#[DECRYPTION_KEY]</code
>. Hash values indicate to the browser where to focus on the page and are never sent to the
server.
</li>
<li>
When opening the note link, the browser retrieves the encrypted note from the server and
decrypts it with the key in the URL.
</li>
</ol>
<p>
If you want to learn more about end-to-end encryption on the Web, I highly recommend <a
href="https://youtu.be/mffWMMVMMLs">this talk</a
> by Thomas Konrad. In the future, I'll write a longer report about the cryptography used in this
project.
If you want to learn further about end-to-end encrypted data transfers on the Web, I highly
recommend <a href="https://youtu.be/mffWMMVMMLs">this talk</a> by Thomas Konrad.
</p>
</div>

1
webapp/src/routes/changelog.svelte
View File

@ -1,6 +1,7 @@
<script context="module" lang="ts">
export const prerender = true;
// @ts-expect-error - Markdown files are not recognized by Svelte
import { toc, html } from '/CHANGELOG.md';
</script>

13
webapp/src/routes/contact.svelte
View File

@ -22,12 +22,8 @@
>GitHub issues page</a
>.
</p>
<p>
If you want a more interactive way to discuss bugs or features, you can join the
<a href="https://discord.gg/y3HqyGeABK">Discord server</a>.
</p>
<h2>Questions about Noteshare.space</h2>
<h2>Inquiries about Noteshare.space</h2>
<p>
For questions and inquiries about Noteshare.space (the "official" note hosting service for the
Obsidian QuickShare plugin), please E-mail me at <a href="mailto:contact@noteshare.space"
@ -35,6 +31,13 @@
>.
</p>
<h2>Community</h2>
<p>
If you want a more interactive way to discuss bugs or features, or just want to chat about how
you use QuickShare and Noteshare.space, you can join the
<a href="https://discord.gg/y3HqyGeABK">Discord server</a>.
</p>
<h2>Get to know me!</h2>
<p>
I’m a computer science engineer with interest in a wide range of topics, including productivity,

49
webapp/src/routes/index.svelte
View File

@ -10,19 +10,8 @@
<title>{import.meta.env.VITE_BRANDING} | Create share links for Obsidian in one click</title>
</svelte:head>
<!-- <div class="prose dark:prose-invert">
<h1>{import.meta.env.VITE_BRANDING}</h1>
<p class="prose-lg">
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco
laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in
voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</p>
</div> -->
<article class="mx-auto max-w-4xl text-zinc-900 dark:text-zinc-100">
<div class="space-y-6 pt-20 pb-24">
<div class="space-y-6 pt-20 pb-24 px-4 md:px-0">
<h1 id="title" class="font-extrabold text-4xl md:text-5xl text-center">
Securely share your <span class="text-[#705dcf]">Obsidian</span> notes with one click.
</h1>
@ -41,7 +30,7 @@
<hr class="border-zinc-200 dark:border-zinc-700 transition-colors" />
<div class="space-y-8 pt-12 md:pt-24 md:pb-16">
<div class="space-y-8 py-12 md:pt-24 md:pb-16">
<div class="flex flex-row gap-4 mx-auto justify-center">
<Tile>
<h2 slot="title">End-to-end encrypted</h2>
@ -81,4 +70,38 @@
<img src="/opensource.svg" alt="encrypted-art" class="w-80 hidden md:block" />
</div>
</div>
<hr class="border-zinc-200 dark:border-zinc-700 transition-colors" />
<div class="mt-12 mb-16 md:px-20">
<h2 class="text-2xl font-bold mb-8">Get in touch!</h2>
<div class="md:grid grid-cols-3 w-full gap-4">
<div class="dark:prose-invert w-full prose mb-4 md:mb-0 text-zinc-700 dark:text-zinc-300">
<h3 class="text-lg font-bold mb-4">Discord</h3>
<p class="">
Join the
<a href="https://discord.gg/y3HqyGeABK">Discord server</a> to discuss bugs and feature requests,
or just to say hi!
</p>
</div>
<div class="dark:prose-invert w-full prose mb-4 md:mb-0 text-zinc-700 dark:text-zinc-300">
<h3 class="text-lg font-bold mb-4">Bug reports</h3>
<p class="">
The preferred way to report bugs or request new features for the web app or the Obsidian
plugin is via the
<a class="underline" href="https://github.com/mcndt/obsidian-quickshare/issues"
>GitHub issues page</a
>.
</p>
</div>
<div class="dark:prose-invert w-full prose mb-4 md:mb-0 text-zinc-700 dark:text-zinc-300">
<h3 class="text-lg font-bold mb-4">Inquiries</h3>
<p class="">
For questions and inquiries about Noteshare.space, please contact me via <a
href="mailto:contact@noteshare.space">contact@noteshare.space</a
>.
</p>
</div>
</div>
</div>
</article>