docs: 💬 Update install page, index page, contact page

This commit is contained in:
Maxime Cannoodt 2022-09-09 00:32:41 +02:00
parent 403ce696bc
commit 7886485f42
3 changed files with 31 additions and 11 deletions

View File

@ -9,12 +9,12 @@
<div class="md:py-8 prose max-w-3xl dark:prose-invert"> <div class="md:py-8 prose max-w-3xl dark:prose-invert">
<h1>Contact</h1> <h1>Contact</h1>
Hi! I'm Hi 🙋 I'm
<a href="https://mcndt.dev">mcndt</a> <a href="https://mcndt.dev">mcndt</a>
and I build the Obsidian QuickShare plugin and operate Noteshare.space. There are several ways to get and I build the Obsidian QuickShare plugin and operate Noteshare.space. There are several ways to get
in touch with me. in touch with me.
<h2>Bugs and feature requests</h2> <h2>🐛 Bugs and feature requests</h2>
<p> <p>
The preferred way to report bugs or request new features for the web app or the Obsidian plugin The preferred way to report bugs or request new features for the web app or the Obsidian plugin
is via the is via the
@ -23,7 +23,7 @@
>. >.
</p> </p>
<h2>Inquiries about Noteshare.space</h2> <h2>Inquiries about Noteshare.space</h2>
<p> <p>
For questions and inquiries about Noteshare.space (the "official" note hosting service for the 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" Obsidian QuickShare plugin), please E-mail me at <a href="mailto:contact@noteshare.space"
@ -31,14 +31,14 @@
>. >.
</p> </p>
<h2>Community</h2> <h2>💬 Community</h2>
<p> <p>
If you want a more interactive way to discuss bugs or features, or just want to chat about how 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 you use QuickShare and Noteshare.space, you can join the
<a href="https://discord.gg/y3HqyGeABK">Discord server</a>. <a href="https://discord.gg/y3HqyGeABK">Discord server</a>.
</p> </p>
<h2>Get to know me!</h2> <h2>👋 Get to know me!</h2>
<p> <p>
Im a computer science engineer with interest in a wide range of topics, including productivity, Im a computer science engineer with interest in a wide range of topics, including productivity,
PKM, artificial intelligence, product development and game design. PKM, artificial intelligence, product development and game design.

View File

@ -11,21 +11,24 @@
</svelte:head> </svelte:head>
<article class="mx-auto max-w-4xl text-zinc-900 dark:text-zinc-100"> <article class="mx-auto max-w-4xl text-zinc-900 dark:text-zinc-100">
<div class="space-y-6 pt-20 pb-24 px-4 md:px-0"> <div class="space-y-6 pt-20 pb-16 md:pb-24 px-4 md:px-0">
<h1 id="title" class="font-extrabold text-4xl md:text-5xl text-center"> <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. Securely share your <span class="text-[#705dcf]">Obsidian</span> notes with one click.
</h1> </h1>
<p id="tagline" class="prose-xl md:prose-2xl text-center text-zinc-700 dark:text-zinc-300"> <p id="tagline" class="prose-xl md:prose-2xl text-center text-zinc-700 dark:text-zinc-300">
Zero configuration. End-to-end encrypted. <br />No account needed. Zero configuration. End-to-end encrypted. <br />No account needed.
</p> </p>
<p id="install-button" class="text-center pt-2"> <div id="install-button" class="text-center pt-8">
<a href="/install"> <a href="/install">
<button <button
class="py-1.5 px-4 rounded-lg border-2 border-[#705dcf] text-[#705dcf] font-semibold hover:bg-[#705dcf] hover:text-white transition-colors" class="py-1.5 px-4 rounded-lg border-2 border-[#705dcf] text-[#705dcf] font-semibold hover:bg-[#705dcf] hover:text-white transition-colors"
>Install plugin</button >Install plugin</button
> >
</a> </a>
</p> <p class="mt-2.5 italic text-sm text-zinc-500 dark:text-zinc-400">
Now on the Obsidian <br /> community plugin marketplace!
</p>
</div>
</div> </div>
<hr class="border-zinc-200 dark:border-zinc-700 transition-colors" /> <hr class="border-zinc-200 dark:border-zinc-700 transition-colors" />

View File

@ -10,10 +10,27 @@
<div class="md:py-8 prose max-w-3xl dark:prose-invert"> <div class="md:py-8 prose max-w-3xl dark:prose-invert">
<h1>Installing the Obsidian Plugin</h1> <h1>Installing the Obsidian Plugin</h1>
The plugin and Noteshare.space are currently in beta. Therefore, the plugin is not yet available <h2>📦 Install from the community plugin marketplace</h2>
through the Obsidian community plugins marketplace.
<h2>Beta testing with BRAT</h2> <p>
If you have Obsidian installed on this device, you can <a
href="obsidian://show-plugin?id=obsidian-quickshare"
>
click here</a
>
to open Obsidian and install the plugin. Alternatively, you can install the plugin manually by following
the instructions below.
</p>
<ol>
<li>Open the Obsidian settings menu.</li>
<li>In the sidebar, click "Community plugins".</li>
<li>Click the "Browse" button on the right.</li>
<li>Type "QuickShare" in the search bar.</li>
<li>Click "Install".</li>
<li><strong>!! Don't forget to activate the plugin after installation !!</strong></li>
</ol>
<h2>👷 Beta testing with BRAT</h2>
<p> <p>
To beta test, you can install the plugin using BRAT and the GitHub URL (<a To beta test, you can install the plugin using BRAT and the GitHub URL (<a