Skip to content

Hello World

Enola captures knowledge about Things, and the relationships (links) between them.

Things can be represented in a variety of Formats. In this 1st step, we’ll use the RDF 🐢 Turtle format.

Let’s start with this greeting1.ttl:

<https://example.org/greeting1>
  <https://example.org/message> "hello, world".

This means that https://example.org/greeting1 identifies some Thing which has a message that is “hello, world”. Pretty simple, right?

Among other things, Enola can generate documentation about Things, like this:

$ ./enola docgen --load docs/models/example.org/greeting1.ttl --output=/tmp/models/ --no-index

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/build

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/.editorconfig

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/.prettierignore

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/.prettierrc.yaml

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/dev

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/.markdownlint.yaml

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/@babel/helper-compilation-targets/node_modules/.bin/semver

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/@babel/core/node_modules/.bin/semver

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/parser

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/esparse

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/js-yaml

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/browserslist

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/node-which

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/json5

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/acorn

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/esvalidate

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/tsc

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/update-browserslist-db

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/jsesc

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/eslint

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/tsserver

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/eslint-config-prettier

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/prettier

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/.bin/semver

WARNING: Ignoring symlink: /home/runner/work/enola/enola/web/node_modules/@istanbuljs/load-nyc-config/node_modules/.bin/js-yaml

greeting1.md now contains:

[https://example.org/greeting1](https://example.org/greeting1)

* [🏺 `enola:origin` Origin](../enola.dev/origin.md):
    * [greeting1.ttl](greeting1.ttl)
* [`ex:message`](https://example.org/message): hello, world

Note how the greeting, in addition to our message from above, automagically got another property named origin - click on it to learn what it’s for! Here is how this Markdown renders:

https://example.org/greeting1