Skip to content

Commit

Permalink
fix/footnotes (#69)
Browse files Browse the repository at this point in the history
* fix: fix footers

* fix: fix footers

* fix: fix footers

Co-authored-by: brittonhayes <[email protected]>
  • Loading branch information
brittonhayes and brittonhayes authored Mar 26, 2022
1 parent 3e8f2f6 commit eb653b7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Pillager provides a terminal user interface built with [bubbletea](https://githu
### Gitleaks Rules

Pillager provides full support for Gitleaks[^gitleaks] rules. This can either be passed
in with a rules.toml[^rules.toml] file, or you can use the default ruleset by leaving the rules flag blank.
in with a rules.toml[^1] file, or you can use the default ruleset by leaving the rules flag blank.

[rules.toml]: https://github.com/zricethezav/gitleaks/blob/57f9bc83d169bea363f2990a4de334b54efc3d7d/config/gitleaks.toml
[^1]: [Gitleaks Rules Reference](https://github.com/zricethezav/gitleaks/blob/57f9bc83d169bea363f2990a4de334b54efc3d7d/config/gitleaks.toml)

```toml
# rules.toml
Expand Down Expand Up @@ -241,7 +241,7 @@ Some examples include `kubectl`, `hugo`, and Github's `gh` CLI.

**What is Gitleaks?**

> Gitleaks is a SAST tool for detecting hardcoded secrets like passwords, api keys, and tokens in git repos.
> Gitleaks[^2] is a SAST tool for detecting hardcoded secrets like passwords, api keys, and tokens in git repos.
Gitleaks is an amazing tool for secret leak prevention. If you haven't implemented Gitleaks as a pre-commit checker,
it's worth your time to check it out.
Expand All @@ -255,7 +255,7 @@ Gitleaks while taking a different approach to presenting and handling the secret
baseline set of default rules, Pillager becomes much more powerful if you allow users to create rules for their own
use-cases.

Check out the included [^rules.toml] for a baseline ruleset.
Check out the included rules[^1] for a baseline ruleset.

---

Expand All @@ -265,9 +265,9 @@ Check out the included [^rules.toml] for a baseline ruleset.
> to scan for secrets on any systems before doing so.
>
> At it's core, Pillager is designed to assist you in determining if a system is affected by common sources of credential leakage as documented
> by the MITRE ATT&CK framework.
> by the MITRE ATT&CK[^3] framework.
>
> [mitre]: https://attack.mitre.org
> [^3]: [MITRE ATT&CK Website](https://attack.mitre.org)
>
> [MITRE ATT&CK Technique - T1552,003 - Unsecured Credentials: Bash History ](https://attack.mitre.org/techniques/T1552/003/)
>
Expand Down

0 comments on commit eb653b7

Please sign in to comment.