Skip to content

Commit

Permalink
docs: tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
ppfeister committed Aug 3, 2024
1 parent 8c52a99 commit 5754a15
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Give us a star on [GitHub]{:target="_blank"} and watch the repository for releas

## Commands

* `sylva config --edit` - Interactively edit the configuration file and add API keys.
* `sylva search [username]` - Run a cursory search for a given string.
* `sylva branch [username]` - Start searching based on a simple string, and branch out as more identities are discovered.
* `sylva --help` - Print help message and exit.
* `#!bash sylva config --edit` - Interactively edit the configuration file and add API keys.
* `#!bash sylva search [username]` - Run a cursory search for a given string.
* `#!bash sylva branch [username]` - Start searching based on a simple string, and branch out as more identities are discovered.
* `#!bash sylva --help` - Print help message and exit.

[GitHub]: https://github.com/ppfeister/sylva
16 changes: 13 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@ Sylva performs best as a Docker container, but several other methods are and wil
The default image reflects the latest tagged release. To fetch the HEAD of `master`, use `ppfeister/sylva:preview`.

```bash
docker run --rm ppfeister/sylva sylva search <query>
docker run --rm ppfeister/sylva sylva search <query> #(1)!
```

1. Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.

```bash
# Alternatively...
docker run --rm -it ppfeister/sylva bash
docker run --rm -it ppfeister/sylva bash #(1)!
sylva search <query>
```

1. Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.

___

## Docker Compose
Expand All @@ -26,8 +32,12 @@ ___
services:
sylva:
container_name: sylva
image: 'ppfeister/sylva'
image: 'ppfeister/sylva' #(1)!
```
1. Sylva can be found on both [Docker Hub][dockerhub]{:target="_blank"} and [GitHub Container Registry][ghcr]{:target="_blank"}.
Users who prefer the latter can opt for `ghcr.io/ppfeister/sylva` instead.

```bash
docker compose run --rm sylva sylva search <query>
```
Expand Down
13 changes: 11 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Sylva
site_url: https://sylva.pfei.cc
site_name: Sylva Identity Discovery
site_url: https://sylva.pfeister.dev
site_author: Paul Pfeister
site_description: Novel identity discovery utility

Expand All @@ -24,6 +24,8 @@ theme:
- search.suggest
- search.highlight
- search.share
- content.code.annotate
- content.code.copy
font:
text: Roboto
code: Roboto Mono
Expand Down Expand Up @@ -110,6 +112,13 @@ extra:
markdown_extensions:
- attr_list
- admonition
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences

nav:
- Home: index.md
Expand Down

0 comments on commit 5754a15

Please sign in to comment.