aoswalt/notoriety repository overview

⁠Notoriety

Notoriously simple note management with markdown and tags.

---

Primary usage is through an escript or docker image.

⁠Installing the Escript

The escript may be built and installed directly from the repo with mix escript.install github aoswalt/notoriety or locally with MIX_ENV=prod mix do escript.build, escript.install.

If you are using asdf⁠ to manage your elixir version, run asdf reshim elixir to create shims for the new escript.

If your elixir is globally installed, make sure ~/.mix/escripts is on your PATH so that any installed escripts are automatically available for use.

⁠Usage

By default, running the script finds all files matched by the pattern notes/**/*.md, builds an index of tags to their notes, and saves an index to index.md.

For more information and overriding the defaults, see the CLI module⁠.

⁠Docker Image

The docker image⁠ expects the working directory to be mounted to /pwd, and because of docker, the resulting file will be created with root permission unless the --user flag is given.

In summary, it can be run with docker run --volume $(pwd):/pwd --user $(id -u):$(id -g) aoswalt/notoriety