diff --git a/docs/develop/docs.md b/docs/develop/docs.md index 8a0a58a5..3017262c 100644 --- a/docs/develop/docs.md +++ b/docs/develop/docs.md @@ -14,6 +14,12 @@ In the project root directory run `mkdocs serve` to run a local version of the d The docs hosted on [docs.browsertrix.cloud](https://docs.browsertrix.cloud) are created from the main branch of [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud) +## Adding icons + +We typically use the [Bootstrap icon set](https://icons.getbootstrap.com/) with our projects. This set is quite expansive, and we don't add the entire set into our docs folder as most icons go unused. If you wish to use an icon when writing documentation to refer to an icon present in part of the app, you may have to download the SVG file and add it to the repo. + +Icons are placed in the `docs/overrides/.icons/iconsetname/iconname.svg` directory, and can be added in markdown files as `:iconsetname-iconname:` accordingly. For more information, see the [Material for MKDocs page on Changing the logo and icons](https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#customization). + ## Docs style guide TODO! \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/bug-fill.svg b/docs/overrides/.icons/bootstrap/bug-fill.svg new file mode 100644 index 00000000..bf164471 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/bug-fill.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/chat-left-text-fill.svg b/docs/overrides/.icons/bootstrap/chat-left-text-fill.svg new file mode 100644 index 00000000..28a0f471 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/chat-left-text-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/check-circle-fill.svg b/docs/overrides/.icons/bootstrap/check-circle-fill.svg new file mode 100644 index 00000000..e861174a --- /dev/null +++ b/docs/overrides/.icons/bootstrap/check-circle-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/exclamation-circle-fill.svg b/docs/overrides/.icons/bootstrap/exclamation-circle-fill.svg new file mode 100644 index 00000000..f7a7d17b --- /dev/null +++ b/docs/overrides/.icons/bootstrap/exclamation-circle-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/exclamation-diamond-fill.svg b/docs/overrides/.icons/bootstrap/exclamation-diamond-fill.svg new file mode 100644 index 00000000..5987fe72 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/exclamation-diamond-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/exclamation-triangle-fill.svg b/docs/overrides/.icons/bootstrap/exclamation-triangle-fill.svg new file mode 100644 index 00000000..50e17525 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/exclamation-triangle-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/eye.svg b/docs/overrides/.icons/bootstrap/eye.svg new file mode 100644 index 00000000..412ff692 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/eye.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/file-earmark-text-fill.svg b/docs/overrides/.icons/bootstrap/file-earmark-text-fill.svg new file mode 100644 index 00000000..b3299197 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/file-earmark-text-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/github.svg b/docs/overrides/.icons/bootstrap/github.svg new file mode 100644 index 00000000..bb4e45ce --- /dev/null +++ b/docs/overrides/.icons/bootstrap/github.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/globe.svg b/docs/overrides/.icons/bootstrap/globe.svg new file mode 100644 index 00000000..96cf8157 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/globe.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/info-circle-fill.svg b/docs/overrides/.icons/bootstrap/info-circle-fill.svg new file mode 100644 index 00000000..9d38231f --- /dev/null +++ b/docs/overrides/.icons/bootstrap/info-circle-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/mastodon.svg b/docs/overrides/.icons/bootstrap/mastodon.svg new file mode 100644 index 00000000..23b34f5c --- /dev/null +++ b/docs/overrides/.icons/bootstrap/mastodon.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/mortarboard-fill.svg b/docs/overrides/.icons/bootstrap/mortarboard-fill.svg new file mode 100644 index 00000000..7f5fb484 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/mortarboard-fill.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/motherboard-fill.svg b/docs/overrides/.icons/bootstrap/motherboard-fill.svg new file mode 100644 index 00000000..bf15e965 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/motherboard-fill.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/pencil-fill.svg b/docs/overrides/.icons/bootstrap/pencil-fill.svg new file mode 100644 index 00000000..59d2830c --- /dev/null +++ b/docs/overrides/.icons/bootstrap/pencil-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/pencil.svg b/docs/overrides/.icons/bootstrap/pencil.svg new file mode 100644 index 00000000..f8dbfebc --- /dev/null +++ b/docs/overrides/.icons/bootstrap/pencil.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/question-circle-fill.svg b/docs/overrides/.icons/bootstrap/question-circle-fill.svg new file mode 100644 index 00000000..d8e5e06d --- /dev/null +++ b/docs/overrides/.icons/bootstrap/question-circle-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/quote.svg b/docs/overrides/.icons/bootstrap/quote.svg new file mode 100644 index 00000000..03b45bf0 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/quote.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/x-octagon-fill.svg b/docs/overrides/.icons/bootstrap/x-octagon-fill.svg new file mode 100644 index 00000000..7872889d --- /dev/null +++ b/docs/overrides/.icons/bootstrap/x-octagon-fill.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/overrides/.icons/bootstrap/youtube.svg b/docs/overrides/.icons/bootstrap/youtube.svg new file mode 100644 index 00000000..86fa4900 --- /dev/null +++ b/docs/overrides/.icons/bootstrap/youtube.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file