emanote

Emanote emanates¹ a structured view of your plain-text notes.

Create beautiful websites -- such as personal webpage, blog, wiki, Zettelkasten, notebook, knowledge-base, documentation, etc. from future-proof plain-text notes and arbitrary data -- with live preview that updates in real-time.

Emanote is spiritual successor to neuron based on Ema.

Installing and using

https://emanote.srid.ca/install

Examples

https://emanote.srid.ca/examples

Developing

Emanote is a Haskell software.² Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code.

See https://github.com/srid/haskell-template for complete instructions, but briefly: Install Nix and run nix develop -c just run.

See architecture for a high-level overview of the codebase.

PR contribution guidelines

You may want to run nix run github:juspay/vira ci -- -b before opening a PR, but the Github Actions will run it as well.

AI-based coding

This repository is set up for AI-based coding with srid/agency and Microsoft APM. Following the motivation in Kolu's contributing guide, contributors are encouraged to open issues with detailed specifications rather than code changes per se.

Discussion

To discuss the emanote project, post in GitHub Discussions.

Footnotes

1. emanate: (of something abstract but perceptible) issue or spread out from (a source) ↩

2. Emanote uses software and resources that are licensed differently, viz.:

   • By default, emanote is licensed: SPDX-License-Identifier: AGPL-3.0-or-later
   • default/index.yaml SPDX-License-Identifier: CC0-1.0 OR AGPL-3.0-or-later
   • default/templates SPDX-License-Identifier: CC0-1.0 OR AGPL-3.0-or-later
   • Logo SPDX-License-Identifier: CC0-1.0
   • Stork search SPDX-License-Identifier: Apache-2.0
   • Tailwind CSS SPDX-License-Identifier: MIT
   • Various SVG icons are from Heroicons SPDX-License-Identifier: MIT
   ↩