Skip to content

Commit ae965fc

Browse files
committed
Markdown lint considered dangerous
1 parent fcd117f commit ae965fc

File tree

7 files changed

+59
-31
lines changed

7 files changed

+59
-31
lines changed

docs/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,17 @@
88
brew install pkgx || curl https://pkgx.sh | sh
99
```
1010

11-
{% hint style='info' %} [Installation Guide](installing-pkgx.md) {% endhint %}
11+
```pwsh
12+
irm https://pkgx.sh | iex # Windows
13+
```
14+
15+
{% hint style='info' %}
16+
[Installation Guide](installing-pkgx.md)
17+
{% endhint %}
1218

1319
## Using `pkgx`
1420

15-
- [Run Anything](running-anything.md)
21+
- [Run Anything](pkgx.md)
1622
- [Scripting](scripting.md)
1723

1824
# The `pkgx` Ecosystem
@@ -26,22 +32,25 @@ used to build a whole ecosystem of tools. Here’s what we’ve built so far:
2632
and any toolset.
2733

2834
{% hint style='info' %}
29-
[https://github.com/pkgxdev/dev](https://github.com/pkgxdev/dev) {% endhint %}
35+
[https://github.com/pkgxdev/dev](https://github.com/pkgxdev/dev)
36+
{% endhint %}
3037

3138
## `pkgm`
3239

3340
`pkgm` installs `pkgx` packages to `/usr/local`.
3441

3542
{% hint style='info' %}
36-
[https://github.com/pkgxdev/pkgm](https://github.com/pkgxdev/pkgm) {% endhint %}
43+
[https://github.com/pkgxdev/pkgm](https://github.com/pkgxdev/pkgm)
44+
{% endhint %}
3745

3846
## `mash`
3947

4048
`mash` is a package manager for scripts that use `pkgx` to make the whole open
4149
source ecosystem available to them.
4250

4351
{% hint style='info' %}
44-
[https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash) {% endhint %}
52+
[https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash)
53+
{% endhint %}
4554

4655
## `pkgo` (Package…GO!)
4756

@@ -50,7 +59,8 @@ instructions that can be… tedious. `pkgo` makes using amazing tools like
5059
[“Stable Diffusion WebUI”] as easy as typing `pkgo` (thanks to `pkgx`).
5160

5261
{% hint style='info' %}
53-
[https://github.com/pkgxdev/pkgo](https://github.com/pkgxdev/pkgo) {% endhint %}
62+
[https://github.com/pkgxdev/pkgo](https://github.com/pkgxdev/pkgo)
63+
{% endhint %}
5464

5565
[“Stable Diffusion WebUI”]: https://github.com/AUTOMATIC1111/stable-diffusion-webui
5666

docs/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010

1111
## The `pkgx` Ecosystem
1212

13-
- [`dev`](https://github.com/pkgxdev/dev)
1413
- [`pkgm`](https://github.com/pkgxdev/pkgm)
14+
- [`dev`](https://github.com/pkgxdev/dev)
1515
- [`mash`](https://github.com/pkgxdev/mash)
16+
- [`pkgo`](https://github.com/pkgxdev/pkgo)
1617

1718
## Appendix
1819

docs/faq.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Typically you want to upgrade `pkgx` so either:
77
1. `brew upgrade pkgx`; or
88
2. `curl -LSsf pkgx.sh | sh`
99

10-
> [!NOTE]
11-
> Yes. Our installer upgrades `pkgx` too.
10+
{% hint style='info' %}
11+
Yes. Our installer upgrades `pkgx` too.
12+
{% endhint %}
1213

1314
## How do I run the latest version of a specific pkg?
1415

@@ -118,10 +119,11 @@ platforms is expertise. Will you help? [Let’s talk].
118119

119120
You need to add to the [pantry](pantry.md).
120121

121-
{% hint style="info" %} Eventually we will support describing how to build or
122+
{% hint style="info" %}
123+
Eventually we will support describing how to build or
122124
obtain distributables for your package via your repo so you can just add a
123-
`pkgx.yaml` and users can use pkgx to use your package automatically. {% endhint
124-
%}
125+
`pkgx.yaml` and users can use pkgx to use your package automatically.
126+
{% endhint %}
125127

126128
## How should I recommend people use my pkg with pkgx?
127129

docs/installing-pkgx.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ irm https://pkgx.sh | iex
2727
# ^^ limited packages so far, list available programs with `pkgx -Q`
2828
```
2929

30-
{% hint style='info' %} Wanna read that script before you run it?
31-
[github.com/pkgxdev/setup/installer.sh][installer] {% endhint %}
30+
{% hint style='info' %}
31+
Wanna read that script before you run it?
32+
[github.com/pkgxdev/setup/installer.sh][installer]
33+
{% endhint %}
3234

3335
## Download Manually
3436

@@ -76,8 +78,8 @@ RUN pkgx +node@16 npm start
7678
```
7779

7880
{% hint style='info' %}
79-
[hub.docker.com/r/pkgxdev/pkgx](https://hub.docker.com/r/pkgxdev/pkgx) {%
80-
endhint %}
81+
[hub.docker.com/r/pkgxdev/pkgx](https://hub.docker.com/r/pkgxdev/pkgx)
82+
{% endhint %}
8183

8284
## GitHub Actions
8385

@@ -86,20 +88,25 @@ endhint %}
8688
```
8789
8890
{% hint style='info' %}
89-
[github.com/pkgxdev/setup](https://github.com/pkgxdev/setup) {% endhint %}
91+
[github.com/pkgxdev/setup](https://github.com/pkgxdev/setup)
92+
{% endhint %}
9093
91-
{% hint style='success' %} `pkgx` makes it easy to consistently use the GNU or
94+
{% hint style='success' %}
95+
`pkgx` makes it easy to consistently use the GNU or
9296
BSD versions of core utilities across different platforms—handy for
93-
cross-platform CI/CD scripts. eg. `pkgx +gnu.org/coreutils ls` {% endhint %}
97+
cross-platform CI/CD scripts. eg. `pkgx +gnu.org/coreutils ls`
98+
{% endhint %}
9499

95100
## Arch Linux
96101

97102
If you're on Arch Linux (or any of it's derivatives) you can also use the
98103
[`pkgx` AUR] (latest released version) or [`pkgx-git` AUR] (latest development
99104
version, might not be stable).
100105

101-
{% hint style='warning' %} The AURs are community-maintained and might be
102-
out-of-date. Use them with caution. {% endhint %}
106+
{% hint style='warning' %}
107+
The AURs are community-maintained and might be
108+
out-of-date. Use them with caution.
109+
{% endhint %}
103110

104111
[GitHub Releases]: https://github.com/pkgxdev/pkgx/releases
105112
[installer]: https://github.com/pkgxdev/setup/blob/main/installer.sh

docs/pkging/pantry-api.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ Visit [dist.pkgx.dev](https://dist.pkgx.dev) for an HTTP index.
1616
`versions.txt` files are newline separated, sorted lists of available versions
1717
for each type of distributable.
1818

19-
{% hint style="warning" %} `dist.pkgx.dev/<PKG>/versions.txt` and the bottle
19+
{% hint style="warning" %}
20+
`dist.pkgx.dev/<PKG>/versions.txt` and the bottle
2021
`versions.txt` may not be the same. Always check the more specific
21-
`versions.txt`. {% endhint %}
22+
`versions.txt`.
23+
{% endhint %}
2224

2325
## The Pantry
2426

docs/pkging/pantry.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
There’s millions of open source projects and `pkgx` needs your help to package
44
them up!
55

6-
{% hint style="success" %} Visit [github.com/pkgxdev/pantry] for the full
7-
documentation. {% endhint %}
6+
{% hint style="success" %}
7+
Visit [github.com/pkgxdev/pantry] for the full documentation.
8+
{% endhint %}
89

9-
{% hint style="info" %} Curious about a specific pkg? `pkgx bk edit deno` will
10-
open deno’s `package.yml` in your editor. {% endhint %}
10+
{% hint style="info" %}
11+
Curious about a specific pkg? `pkgx bk edit deno` will open deno’s
12+
`package.yml` in your editor.
13+
{% endhint %}
1114

12-
# Packagers Who Care
15+
## Packagers Who Care
1316

1417
You trust us to just work and make your workflows happen. We take this job
1518
seriously and we go the extra mile on a per-package basis, for example:

docs/scripting.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ $ ./my-script.py
1616
3.9.17
1717
```
1818

19-
{% hint style="info" %} Using `env` to invoke `pkgx` is typical for tools that
19+
{% hint style="info" %}
20+
Using `env` to invoke `pkgx` is typical for tools that
2021
have no POSIX location.
2122

22-
The `-S` parameter is required to pass multiple arguments. {% endhint %}
23+
The `-S` parameter is required to pass multiple arguments.
24+
{% endhint %}
2325

2426
## Including Additional pkgs
2527

@@ -33,7 +35,8 @@ script.
3335
Deno.dlopen("libssl.dylib")
3436
```
3537

36-
{% hint style="info" %} Robustness requires precisely specifying your
38+
{% hint style="info" %}
39+
Robustness requires precisely specifying your
3740
environment:
3841

3942
```sh

0 commit comments

Comments
 (0)