amerlyq / nou.vim

Notes, outlines, mind maps, decision-making, cheetsheets, documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nou.vim

Build Status

Notes and outline united.

It's similar to org-mode but in no way compatible and there is no plans to make it so. It was developed especially because my primary usecases look ugly in org-mode syntax too much (for my taste).

Capabilities

  • extensive outline with contrasting visual distinctions between levels
  • plain notes in paragraphs
  • annotated decision making
  • web links hierarchy with titles
  • streamlined dataflows and callgraphs
  • inlined shell code examples
  • simple todo lists for weekly planning with priorities
  • cheat-sheets for programs
  • documentation
  • opinionated mind mapping

You can find non-exhaustive but acceptable list of possible syntax constructs inside of docs.

  • doc/nou-markup.txt
  • doc/nou-path.txt
  • doc/nou-keyvalue.txt

Examples

You can see many examples of actually written and daily used docs in:

Of course you must have installed plugin first, otherwise without highlighting you won't know, if it's individually nice to use or not.

TODO: add some direct links to ./doc dirs/files -- as examples of extensive usage of *.nou

Add-ons

Everywhere-notches

Enumeration of 100+ operator keywords highlighted everywhere over any other syntax file. Useful to create personal action accents in programming comments, tasks, etc.

(I still haven't decided if it needs separate repo)

Xtref

Timestamp-based cross-refs manipulation and tagging by braille-codes. Allows you to tag and jump between your own knowledge database scattered over multiple repos. Auto-annotate copied web-links to refer them from other places

(Planned to be merged with tenjo and published as separate multirepo)

Tenjo

Distributed collaborative task-management specification and solution.

Actually git is much better than taskwarrior for this kind of staff. Moreover it's often desirable to keep together tasks and temporary binary artifacts (like books) alongside source code and documentation. In that case git-annex or git-lfs help immeasurably. We only need a way to manage and distribute tasks in git.

Contribution

I really appreciate any snippet of documentation/code you can contribute, -- if you find examples above personally appealing and useful. After all I by myself can't compare with whole org-mode community :)

Alternatively you can propose some workflow -- useful for you personally. And I will implement it, if it has a nice vibe to it.

Also you can look into todo/* long list of expected but still not implemented features -- I hope some interesting ideas may inspire you.

Inspired from

About

Notes, outlines, mind maps, decision-making, cheetsheets, documentation.

License:GNU General Public License v3.0


Languages

Language:Vim Script 99.0%Language:Shell 0.8%Language:Makefile 0.2%