Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial submission of Notr. #8975

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Initial submission of Notr. #8975

merged 2 commits into from
Nov 20, 2024

Conversation

cepthomas
Copy link
Contributor

  • I'm the package's author and/or maintainer.
  • I have have read [the docs][1].
  • I have tagged a release with a [semver][2] version number.
  • My package repo has a description and a README describing what it's for and how to use it.
  • My package doesn't add context menu entries. *
  • My package doesn't add key bindings. **
  • Any commands are available via the command palette.
  • Preferences and keybindings (if any) are listed in the menu and the command palette, and open in split view.
  • If my package is a syntax it doesn't also add a color scheme. ***
  • If my package is a syntax it is named after the language it supports (without suffixes like "syntax" or "highlighting").
  • I use [.gitattributes][3] to exclude files from the package: images, test files, sublime-project/workspace.

Notr is a Sublime Text application plugin for displaying and managing collections of text notes.
It is a plain text format with some similarity to markdown. However there is no rendering-for-publication step: the text itself is the whole point.

Some key features:

  • Sections with tags and simple (non-hierarchal) folding.
  • References to section, file (image or other), uri.
  • Navigation to targets via quick panel. Has MRU and sticky entries.
  • Lists with several bullet types.
  • Tables with insert/delete column, fit, sort.
  • Multiple notr projects.
  • Search in all project notr files.
  • Works well with Render View to generate static output.

I couldn't find anything in current Package Control that did what I wanted because:

  • Too simplistic.
  • Too complicated, usually with onerous configuration and dependencies.
  • Poor code quality -> unmaintainable.
  • Abandoned.

A few that I looked at:

This is one of several plugins I'm submitting to Package Control for consideration. I've been
refining them for several years and use them daily. I think they could be useful to others, in whole or as parts.

Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated testing result: SUCCESS

Repo link: Notr

Packages added:
  - Notr

Processing package "Notr"
  - All checks passed

@braver
Copy link
Collaborator

braver commented Nov 19, 2024

However there is no rendering-for-publication step: the text itself is the whole point.

Well you could say the same for markdown 😅 But for sure, this is an interesting project!

We already covered some topics in your other packages, we don't need to go through that again. I have only tiny nit picks or questions:

  • markup.bold etc should probably also get the .notr suffix?
  • view.syntax().name is fine, especially since you ship with the syntax and it's unlikely to get an alternative. But normally I'd match on scope (I've always found the "syntax" api interface weird on that point). 🤷🏻

repository/n.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated testing result: SUCCESS

Repo link: Notr

Packages added:
  - Notr

Processing package "Notr"
  - All checks passed

@cepthomas
Copy link
Contributor Author

However there is no rendering-for-publication step: the text itself is the whole point.

Well you could say the same for markdown

Sort of but it's clumsy. This project attempted to improve that process plus add the notion of linked text, searchable, navigation etc without requiring a rendering step. I would also like to "embed" other resource types too. Phantoms, annotations might be useful.

  • markup.bold etc should probably also get the .notr suffix?

OK.

  • view.syntax().name is fine, especially since you ship with the syntax and it's unlikely to get an alternative. But normally I'd match on scope (I've always found the "syntax" api interface weird on that point). 🤷🏻

OK, slightly better.

@braver
Copy link
Collaborator

braver commented Nov 20, 2024

Don’t forget to tag your latest work!

@braver braver merged commit c726ce0 into wbond:master Nov 20, 2024
2 checks passed
@cepthomas
Copy link
Contributor Author

Don’t forget to tag your latest work!

Yup, just waiting for the merge in case there were other odds and ends.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants