Coder Social home page Coder Social logo

obsidian-share's Introduction

Share Note

Instantly share / publish a note. Notes are shared with your full theme and should look identical to how they look in your Obsidian vault.

To share a note, choose Share Note from the command palette, or click the โ‹ฎ menu in any note and choose Copy shared link


Full theme support

Uploads using your current theme, along with all your options and custom CSS snippets.

Supports all Obsidian content types:

Images!

Dataview queries!

Here's an example inline Dataview query. It will be correctly rendered when sharing:

The answer is `= 7 + 8`!

The answer is 15!

Callouts!

Links between notes!

If your shared note links to another note which is also shared, that link will also function on the shared webpage.

Code blocks!

function doYouEven(haveToAsk) {
  return 'Of course we can do it!'
}

Checkboxes! Tags!

Project Manhattan: #in-progress #behind-schedule

  • Start project
  • Procrastinate
  • Finish project

Internal links

Share a table of contents and jump around your document.


Usage

Use the Share Note command from the Command Palette. You can map it to a hotkey to make things faster.

The first time a file is shared, the plugin will automatically upload all your theme styles. The next time you share a file, it will use the previously uploaded theme files.

If you want to force the theme CSS to update, use the command Force re-upload of all data for this note.


Encryption

The content of your note is encrypted by default. What this means is that you can read the note, and the person you send it to can read the note, but nobody else can read the content - not even the hosting server.

๐Ÿ›ˆ Encryption is optional, and can be turned on/off for individual notes, or for all notes, whatever you prefer.

๐Ÿง‘โ€๐Ÿ’ป How it works

When you share an encrypted note, you'll get a share link that looks like this:

https://share.note.sx/4earajc8#PtC3oQDjDQK9VP7fljmQkLBA/rIMb2tbFsGoG44VdFY

This part is the link to the file:

https://share.note.sx/4earajc8

If you click on it, you'll see a message that says "Encrypted note", because you haven't provided the decryption key.

The decryption key is the second part of the share link after the # symbol:

#PtC3oQDjDQK9VP7fljmQkLBA/rIMb2tbFsGoG44VdFY

When you combine those two things together, the note is able to be decrypted and you can see the content:

https://share.note.sx/4earajc8#PtC3oQDjDQK9VP7fljmQkLBA/rIMb2tbFsGoG44VdFY

The decryption key only exists inside your vault, and is only known to you and whoever you send the link to. Nobody else can read the content.

You may optionally share an unencrypted version of a note by using the frontmatter checkbox property share_unencrypted = โœ…. This note you are currently reading is shared unencrypted.

If you decide you want to share most notes unencrypted by default, then you can encrypt an individual note by using a frontmatter checkbox called share_encrypted.

Troubleshooting

See here: Troubleshooting

obsidian-share's People

Contributors

alangrainger avatar thecolorman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.