Skip to content

Commit d580514

Browse files
committed
add macros plugin
1 parent 4396e04 commit d580514

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

docs/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Agent is responsible for building packages. You'll need it to build packages locally. There are multiple ways to install it:
66

7-
1. OmniPackage repositories [web.omnipackage.org/oleg/omnipackage-agent](https://web.omnipackage.org/oleg/omnipackage-agent)
8-
2. [Source code](https://github.com/omnipackage/omnipackage-agent-ruby). Reasonably recent version of Ruby required. Executables located in `exe/` directory
7+
1. OmniPackage repositories [{{agent_public_install_url | replace("http://", "")|replace("https://", "") }}]({{ agent_public_install_url }})
8+
2. [Source code]({{ agent_github_url }}). Reasonably recent version of Ruby required. Executables located in `exe/` directory
99

1010
Test your installation
1111
```shell
@@ -16,7 +16,7 @@ Agent requires `podman` or `docker` as well as few other common Linux programs.
1616

1717
## Building example project
1818

19-
1. Clone [examples](https://github.com/omnipackage/examples) repository
19+
1. Clone [examples]({{ examples_url }}) repository
2020
2. `cd examples`
2121
3. `omnipackage build c_makefile`
2222

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@
44

55
There are 2 main components:
66

7-
1. [Agent](https://github.com/omnipackage/omnipackage-agent-ruby) - responsible for building packages. Can be used as stand-alone or as a build agent connected to the server-side
8-
2. [Server-side aka web](https://github.com/omnipackage/omnipackage-web) - responsible for web UI, package signing and repositories management. Managed version [web.omnipackage.org](https://web.omnipackage.org). Can be [self-hosted](self_hosting.md)
9-
7+
1. [Agent]({{ agent_github_url }}) - responsible for building packages. Can be used as stand-alone or as a build agent connected to the server-side
8+
2. [Server-side aka web]({{ web_github_url }}) - responsible for web UI, package signing and repositories management. Managed version [{{ web_hosted_url | replace("http://", "")|replace("https://", "") }}]({{ web_hosted_url }}). Can be [self-hosted](self_hosting.md)

mkdocs.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@ nav:
1111
- 'Self-hosting': self_hosting.md
1212
- About: about.md
1313

14-
14+
extra:
15+
web_github_url: https://github.com/omnipackage/omnipackage-web
16+
agent_github_url: https://github.com/omnipackage/omnipackage-agent-ruby
17+
web_hosted_url: https://web.omnipackage.org
18+
examples_github_url: https://github.com/omnipackage/examples
19+
agent_public_install_url: https://web.omnipackage.org/oleg/omnipackage-agent
1520

1621

1722

@@ -60,6 +65,7 @@ plugins:
6065
- search
6166
- privacy
6267
- git-revision-date-localized
68+
- macros
6369

6470

6571
extra_css:

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ mkdocs-material
33
mkdocs-material[imaging]
44
mkdocs-git-revision-date-localized-plugin
55
Pygments
6+
mkdocs-macros-plugin

0 commit comments

Comments
 (0)