Coder Social home page Coder Social logo

sokach-dev / obsidian-sidenote-callout Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xhuajin/obsidian-sidenote-callout

0.0 0.0 0.0 1.14 MB

By leveraging only CSS and callout, elegantly implement marginal notes

License: MIT License

CSS 100.00%

obsidian-sidenote-callout's Introduction

obsidian-sidenote-callout

中文版

Using the built-in callout syntax in Obsidian, it keeps notes clean and is extremely simple to use. Testing page is generaged by menzi11/BullshitGenerator(github.com)

Obsidian Nord - light

Theme:Obsidian Nord

minimal - dark

Theme: minimal

Feature

  • Achieve side note effects by rendering callouts with CSS.
  • It can be correctly renderred in both Live Preview mode and Reading View.
  • Adaptable to multiple themes.

Usage

Before we use it, download the sidenote-callout.css and add the css to your vault.

If you want the annotation to appear on the left side, you should phrase it like this.

> [!NOTE|aside-l] annotation
> annotation on the left side

If you want the annotation to appear on the right side, change aside-l to .

> [!NOTE|aside-r] annotation
> annotation on the right side

The folding syntax of callouts is also applicable.

> [!NOTE|aside-l]+ annotation
> Default-expanded annotations.
> [!NOTE|aside-r]- annotation
> Default-collapsed annotations.

Try different types of callouts.

> [!ERROR|aside-l] ERROR Style
> Other style is available too.(important, tip, cite and even your customized callout styles.)

Style Settings

You can customize the style of sidenotes using the Style Settings plugin.

sidenote-style-setting

For example:

  • Enable Callout Background
  • place the sidenote title at the top
  • Enable Hide Fold Icon

Obsidian Nord - light

Theme:Obsidian Nord

minimal - dark

Theme: minimal

Shortcomings

  • The screen can only be fully displayed if it is large enough, and it may not be fully displayed when it is split on a phone or computer.
  • Sidenote callout titles should not be too long if the callout-title is not set to top, cause it may cause deformation.
  • The support for exporting styles to PDF is in progress.(doing)
  • The position of sidenote callout can only be on the side, can not move up and down.(doing)

Reference

Special thanks

obsidian-sidenote-callout's People

Contributors

xhuajin 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.