Code Monkey home page Code Monkey logo

obsidian-note-splitter's Introduction

Obsidian Note Splitter

Obsidian Downloads

Note splitter is an Obsidian.md plugin for desktop only. It allows you to split a single note into many notes based on a sequence of characters (a delimiter).

Table of contents

Videos

Split a note using default settings.

Screen.Recording.2024-06-27.at.9.57.24.PM.mov

Split a note with use first line as title enabled.

Screen.Recording.2024-06-27.at.9.58.29.PM.mov

Installation

  1. In Obsidian, open Settings
  2. Go to Community plugins
  3. Select Browse
  4. Search for Note Splitter by DecafDev
  5. Select Install
  6. Then select Enable

Usage

  1. Open a note that you want to split
  2. Switch to editing mode
  3. Open the Obsidian command palette
  4. Type Split by delimiter
  5. Press enter
  6. See split notes in the output folder

Note

Splitting a note will not modify the original note.

Frontmatter

When splitting a note, frontmater is ignored. Only content after the frontmatter block is split.

Settings

Output folder

The folder to save split notes in. If the input is empty, the folder of the original note will be used.

Note

Default value is note-splitter

Delimiter

The sequence of characters to split by. When you split a note, the content before and after each delimiter will become new notes.

Note

The default value is a newline character \n

Remove delimiter

If enabled, the delimiter will not be included in the content of split notes.

For example, suppose you have two sentences and your delimiter is set to a period ..

This is sentence 1. This is sentence 2.

If this setting is enabled, the output will be:

This is sentence 1
This is sentence 2

If you wanted to retain the period in each split note, you could disable this setting. The output would then be:

This is sentence 1.
This is sentence 2.

Note

Enabled by default.

Use first line as title

If enabled, the first line of split content will be used as the title of the split note. If the title already exists, the conflict will be indicated by naming the note as Split conflict <random-uuid>.

If disabled, a timestamp will be used as the title e.g. note-splitter-1702591910.

Note

Disabled by default.

Removed characters

Depending on your operating system, Obsidian will not allow certain characters in a file name.

When Use first line as title is enabled, invalid characters in the first line will be removed.

Character Removed On
* Windows
" Windows
` Windows
? Windows
< Windows
> Windows
: Windows, macOS, Linux
\ Windows, macOS, Linux
/ Windows, macOS, Linux
^ Windows, macOS, Linux
[ Windows, macOS, Linux
] Windows, macOS, Linux
# Windows, macOS, Linux

Append to split content

This is text that should appended to the content of each split note.

Delete original

If enabled, the original note will be deleted after a successful split.

Note

Disabled by default.

Learn more

Steps to create Anki flashcards from an English article, using Yanki, ChatGPT, Note Splitter by @jdevtw

Contributing

Issues and pull requests are welcome.

License

Note Splitter is distributed under MIT License

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.