Skip to content
/ YANP Public

Notetaking plugin that supports recurring topics structure and customisable syntax.

License

Notifications You must be signed in to change notification settings

boson-joe/YANP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

YANP

Notetaking plugin that supports recurring topics structure and customisable syntax.

YANP - Yes, Another Notetaking Plugin.


Table of contents


Description

Long story short, here are the main features of this plugin that may distinguish it from the others:

  • Recursive structure. Every topic is represented with its own directory within recursive structure of subdirectories. YANP handles creation of files and directories, maintains this structure as well as provides simple user interface for defining links to different files.

yanp_structure

  • Customizable syntax plugin. YANP doesn't handle syntax by itself - thus you can choose any markup syntax (like Markdown, HTML, etc) you want to define links between files, provided you have a plugin that utilizes YANP API. By default, YANP works with MarkdowneyJr Markdown formatting plugin. The list plugins know to integrate YANP can be found here.

  • API for syntax formatting plugins. YANP delegates syntax formatting (like replacing selected text with a link to a desired file) to other plugins while providing a clear API that allows maintaining a unified structure of notes. Definition of exact paths to files and its creation is done by YANP, syntax plugin is only responsible for replacing a text with a link. Documentation for the API is provided to make syntax plugin integration easier.

  • Links. Links are everywhere. Defined with a single keystroke.

  • Customization. You can change quite a lot of stuff, starting from names of index files and default contents of created files, till how the path for different types of files will look like.

  • Fast access to last created files, last visited index files, today's fast notes, and other supplementary, but useful features.

Please refer to the User Guide, Customization Guide, Installation Guide or YANP Integration Guide to see how to use different features of the plugin, install it or integrate your syntax plugin, respectively.

Please refer to the Contacts page if you would like to contact the devs.

Navigation Bar

[User Guide] [Customization Guide] [Installation Guide] [Integration Guide] [License] [Development] [Contacts]


Go up

About

Notetaking plugin that supports recurring topics structure and customisable syntax.

Resources

License

Stars

Watchers

Forks

Packages

No packages published