Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srid/emanote
Emanate a structured view of your plain-text notes
https://github.com/srid/emanote
ema haskell markdown obsidian-md orgmode pandoc static-site zettelkasten
Last synced: 6 days ago
JSON representation
Emanate a structured view of your plain-text notes
- Host: GitHub
- URL: https://github.com/srid/emanote
- Owner: srid
- License: other
- Created: 2021-05-09T15:21:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T22:53:45.000Z (about 1 month ago)
- Last Synced: 2024-12-03T00:32:48.666Z (9 days ago)
- Topics: ema, haskell, markdown, obsidian-md, orgmode, pandoc, static-site, zettelkasten
- Language: Haskell
- Homepage: https://emanote.srid.ca
- Size: 6.01 MB
- Stars: 820
- Watchers: 16
- Forks: 72
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- my-awesome-github-stars - srid/emanote - Emanate a structured view of your plain-text notes (Haskell)
- awesome-note-taking - Emanate - A structured view of your plain-text notes. Succesor to neuron. (Open Source / Editor Plugin)
- awesome-starred - srid/emanote - Emanate a structured view of your plain-text notes (markdown)
- jimsghstars - srid/emanote - Emanate a structured view of your plain-text notes (Haskell)
README
# emanote
[](https://en.wikipedia.org/wiki/Affero_General_Public_License)
[](https://builtwithnix.org)
[](https://app.element.io/#/room/#ema:matrix.org "Chat on Matrix")
[](https://srid.ca/coc "This project follows the 'Harmlessness Code of Conduct'")
Emanote emanates[^def] a structured view of your plain-text notes.
[^def]: **emanate**: *(of something abstract but perceptible) issue or spread out from (a source)*
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](https://neuron.zettel.page) based on [Ema](https://ema.srid.ca).
## Installing and using
https://emanote.srid.ca/start/install
### Examples
https://emanote.srid.ca/examples
## Developing
Emanote is a Haskell software.[^licenses] Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code.
See https://srid.ca/haskell-template/start for complete instructions, but briefly: [Install Nix](https://nixos.asia/en/install) and run `nix develop -c just run`.
See [architecture](https://emanote.srid.ca/architecture) for a high-level overview of the codebase.
### PR contribution guidelines
You may want to run `nix run github:juspay/omnix ci run` before opening a PR, but the CI will run it as well.
## Discussion
To discuss the emanote project, [join Matrix][matrix] or post in [GitHub Discussions][ghdiscuss].
[matrix]: https://matrix.to/#/#ema:matrix.org
[ghdiscuss]: https://github.com/srid/emanote/discussions
[^licenses]: 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](default/index.yaml) `SPDX-License-Identifier: CC0-1.0 OR AGPL-3.0-or-later`
- [default/templates](default/templates) `SPDX-License-Identifier: CC0-1.0 OR AGPL-3.0-or-later`
- [Logo](https://www.svgrepo.com/svg/267765/paper-plane) `SPDX-License-Identifier: CC0-1.0`
- [Stork search](https://github.com/jameslittle230/stork/blob/master/license.txt) `SPDX-License-Identifier: Apache-2.0`
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss/blob/master/LICENSE) `SPDX-License-Identifier: MIT`
- Various SVG icons are from [Heroicons](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE) `SPDX-License-Identifier: MIT`