Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix (docs): Run ExecMD for all *.md (and other docz fixes) #349

Merged
merged 1 commit into from
Dec 2, 2023
Merged

fix (docs): Run ExecMD for all *.md (and other docz fixes) #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions core/lib/src/main/java/dev/enola/core/meta/enola_meta.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@ option go_package = "dev/enola/core/meta";
// TODO Enable this, with validation that entities don't have it, and
// "complete" it on read string package = 1;

// List of entities kinds of this model.
// repeated EntityKind entities = 2;
// }

message EntityKinds {
repeated EntityKind kinds = 1;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/use/execmd/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A code block such as this one in [`demo.md`](../../../docs/use/execmd/demo.md):
```
```

when ran through `./enola execmd docs/use/execmd/index.md` produces:
when ran through `./enola execmd docs/use/execmd/demo.md` produces:

```bash
$ echo Hi
Expand Down
26 changes: 13 additions & 13 deletions docs/use/help/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,32 @@ $ ./enola
...
```

Each sub-command's help can be shown either with `enola help SUBCOMMAND` or `enola SUBCOMMAND --help`.
Each sub-command's help can be shown either with `enola help SUBCOMMAND` (better) or `enola SUBCOMMAND --help` (not recommended).

## DocGen

[Documentation Generation](../docgen/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola docgen --help
```bash cd .././.././..
$ ./enola help docgen
...
```

## Get

[Get Entity](../get/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola get --help
```bash cd .././.././..
$ ./enola help get
...
```

## List

[List Entities](../list/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola list --help
```bash cd .././.././..
$ ./enola help list
...
```

Expand All @@ -66,26 +66,26 @@ Because Entity Kinds are Entites themselves, `list` [can also be used to see the

[The built-in HTTP Web Server](../server/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola server --help
```bash cd .././.././..
$ ./enola help server
...
```

## ExecMD

[Executable Markdown](../execmd/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola execmd --help
```bash cd .././.././..
$ ./enola help execmd
...
```

## Rosetta

[Rosetta](../rosetta/index.md) has the following options:

```bash $? cd .././.././..
$ ./enola rosetta --help
```bash cd .././.././..
$ ./enola help rosetta
...
```

Expand Down
5 changes: 2 additions & 3 deletions tools/demo/build.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,14 @@
set -euo pipefail

SCRIPT_DIR=$(realpath "$1")
MD=$(realpath "$SCRIPT_DIR/index.md")
SCRIPT=$(realpath "$SCRIPT_DIR/script")
TOOLS_DIR=$(realpath "$(dirname "$0")")
ENOLA="$TOOLS_DIR"/../../enola
CWD=$(pwd)
cd "$SCRIPT_DIR"

echo ./enola execmd -i "$MD" ...
"$ENOLA" -vvvvvvv execmd -i "$MD"
echo ./enola execmd -i "$SCRIPT_DIR"/*.md ...
"$ENOLA" -vvvvvvv execmd -i "$SCRIPT_DIR"/*.md

# This script produces https://asciinema.org-like documentation from demo scripts!
# It uses the great https://github.com/zechris/asciinema-rec_script to achieve this.
Expand Down