diff --git a/.vscode/cSpell.json b/.vscode/cSpell.json index 6dfb3b666..edac1c21e 100644 --- a/.vscode/cSpell.json +++ b/.vscode/cSpell.json @@ -22,7 +22,8 @@ "target/**", "tests/**/fixtures/**", "src/uu/dd/test-resources/**", - "vendor/**" + "vendor/**", + "**/*.svg" ], // words to ignore (even if they are in the flagWords) diff --git a/docs/src/index.md b/docs/src/index.md index c51fbb198..7bac8b816 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,20 +1,49 @@ +{{#include logo.svg}} + + + # uutils Coreutils Documentation -uutils is an attempt at writing universal (as in cross-platform) CLI -utilities in [Rust](https://www.rust-lang.org). It is available for -Linux, Windows, Mac and other platforms. +uutils is an attempt at writing universal (as in cross-platform) CLI utilities +in [Rust](https://www.rust-lang.org). It is available for Linux, Windows, Mac +and other platforms. -The API reference for `uucore`, the library of functions shared between -various utils, is hosted at -[docs.rs](https://docs.rs/uucore/latest/uucore/). +The API reference for `uucore`, the library of functions shared between various +utils, is hosted at [docs.rs](https://docs.rs/uucore/latest/uucore/). -uutils is licensed under the [MIT License](https://github.com/uutils/coreutils/blob/main/LICENSE). +uutils is licensed under the +[MIT License](https://github.com/uutils/coreutils/blob/main/LICENSE). ## Useful links -* [Releases](https://github.com/uutils/coreutils/releases) -* [Source Code](https://github.com/uutils/coreutils) -* [Issues](https://github.com/uutils/coreutils/issues) -* [Discord](https://discord.gg/wQVJbvJ) -> Note: This manual is automatically generated from the source code and is -> a work in progress. +- [Releases](https://github.com/uutils/coreutils/releases) +- [Source Code](https://github.com/uutils/coreutils) +- [Issues](https://github.com/uutils/coreutils/issues) +- [Discord](https://discord.gg/wQVJbvJ) + +> Note: This manual is automatically generated from the source code and is a +> work in progress. diff --git a/docs/src/logo.svg b/docs/src/logo.svg new file mode 100644 index 000000000..4ee0a4740 --- /dev/null +++ b/docs/src/logo.svg @@ -0,0 +1,61 @@ + diff --git a/docs/theme/favicon.png b/docs/theme/favicon.png deleted file mode 100644 index 1cd1f26ec..000000000 Binary files a/docs/theme/favicon.png and /dev/null differ diff --git a/docs/theme/favicon.svg b/docs/theme/favicon.svg new file mode 100644 index 000000000..bac1d8619 --- /dev/null +++ b/docs/theme/favicon.svg @@ -0,0 +1,79 @@ +