From 2a78a48b6f5b04a37b1cc9b80d2322861ce5297b Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Tue, 2 Apr 2024 17:31:03 +0200 Subject: [PATCH 1/2] remove oranda in favour of zola pages --- .github/workflows/docs.yml | 14 ++++++++------ content/coreutils.md | 24 ++++++++++++++++++++++++ content/diffutils.md | 16 ++++++++++++++++ content/findutils.md | 20 ++++++++++++++++++++ static/style.css | 24 ++++++++++++++++++++---- templates/project.html | 18 ++++++++++++++++++ 6 files changed, 106 insertions(+), 10 deletions(-) create mode 100644 content/coreutils.md create mode 100644 content/diffutils.md create mode 100644 content/findutils.md create mode 100644 templates/project.html diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 315abe826..d717c75f8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -47,21 +47,23 @@ jobs: run: | curl https://tldr.sh/assets/tldr.zip --output coreutils/docs/tldr.zip - - name: Install necessary tools (oranda, mdbook and mdbook-toc) + - name: Install necessary tools (mdbook and mdbook-toc) uses: taiki-e/install-action@v2 with: - tool: oranda,mdbook,mdbook-toc + tool: mdbook,mdbook-toc - name: Build Coreutils Docs run: | cd coreutils cargo run --bin uudoc --all-features - oranda build + cd docs + mdbook build - name: Build Findutils Docs run: | cd findutils - oranda build + cd docs + mdbook build - name: Run Zola uses: shalzz/zola-deploy-action@v0.18.0 @@ -72,8 +74,8 @@ jobs: - name: Collect results into `public` folder run: | cp -r uutils.github.io/public public - cp -r coreutils/public public/coreutils - cp -r findutils/public public/findutils + cp -r coreutils/docs/book public/coreutils/docs + cp -r findutils/docs/book public/findutils/docs - name: Upload artifact for checking the output uses: actions/upload-artifact@v4 diff --git a/content/coreutils.md b/content/coreutils.md new file mode 100644 index 000000000..4d38ef14c --- /dev/null +++ b/content/coreutils.md @@ -0,0 +1,24 @@ ++++ + +title = "coreutils" +template = "project.html" + ++++ + +uutils coreutils is a cross-platform reimplementation of the GNU coreutils in Rust. While all programs have been implemented, some options might be missing or different behavior might be experienced. + +# Goals + +This project aims to be a drop-in replacement for the GNU utils. Differences with GNU are treated as bugs. + +uutils aims to work on as many platforms as possible, to be able to use the same utils on Linux, Mac, Windows and other platforms. This ensures, for example, that scripts can be easily transferred between platforms. + +# Contributing + +To contribute to uutils coreutils, please see [CONTRIBUTING](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md). + +# License + +uutils coreutils is licensed under the MIT License - see the [LICENSE](https://github.com/uutils/coreutils/blob/main/LICENSE) file for details. + +GNU Coreutils is licensed under the GPL 3.0 or later. diff --git a/content/diffutils.md b/content/diffutils.md new file mode 100644 index 000000000..b10527503 --- /dev/null +++ b/content/diffutils.md @@ -0,0 +1,16 @@ ++++ + +title = "diffutils" +template = "project.html" + ++++ + +Rust implementation of GNU diffutils: `diff`, `cmp` and `diff`. + +This project aims to be a drop-in replacement of the original commands. + +# License + +uutils diffutils is licensed under the MIT or Apache License - see the [LICENSE-MIT](https://github.com/uutils/diffutils/blob/main/LICENSE-MIT) and [LICENSE-APACHE](https://github.com/uutils/diffutils/blob/main/LICENSE-MIT) file for details. + +GNU diffutils is licensed under the GPL 3.0 or later. diff --git a/content/findutils.md b/content/findutils.md new file mode 100644 index 000000000..28a0796c2 --- /dev/null +++ b/content/findutils.md @@ -0,0 +1,20 @@ ++++ + +title = "findutils" +template = "project.html" + ++++ + +Rust implementation of GNU findutils: `xargs`, `find`, `locate` and `updatedb`. + +This project aims to be a drop-in replacement of the original commands. + +# Contributing + +To contribute to uutils findutils, please see [CONTRIBUTING](https://github.com/uutils/findutils/blob/main/CONTRIBUTING.md). + +# License + +uutils findutils is licensed under the MIT License - see the [LICENSE](https://github.com/uutils/findutils/blob/main/LICENSE) file for details. + +GNU findutils is licensed under the GPL 3.0 or later. diff --git a/static/style.css b/static/style.css index 53d5b442d..135b7fb4e 100644 --- a/static/style.css +++ b/static/style.css @@ -5,8 +5,8 @@ --dark-bg-color: var(--light-fg-color); --fg-color: var(--light-fg-color); --bg-color: var(--light-bg-color); - --light-link-color: #0284c7; - --dark-link-color: #8bb9fe; + --light-link-color: #c04828; + --dark-link-color: #c04828; --link-color: var(--light-link-color); --light-highlight-bg-color: #ededed; --light-highlight-fg-color: #595959; @@ -340,7 +340,7 @@ footer { .title { font-size: 3em; - font-weight: bold; + font-weight: 900; margin-bottom: 0.5em; } @@ -378,4 +378,20 @@ footer { blockquote { border-left: 0.2em solid gray; padding-left: 1em; -} \ No newline at end of file +} + +.links { + display: flex; + justify-content: stretch; + gap: 1em; + margin-bottom: 2em; + font-size: 1.2em; +} + +.links > a { + padding: 0.2em 1em; + color: #c04828; + border: 2px solid #c04828; + flex: 1; + text-align: center; +} diff --git a/templates/project.html b/templates/project.html new file mode 100644 index 000000000..a70dd4506 --- /dev/null +++ b/templates/project.html @@ -0,0 +1,18 @@ +{%- extends "base.html" -%} + +{%- block title -%} + {{ page.title }} | uutils +{%- endblock title -%} + +{%- block main -%} +
{{ page.title }}
+ +
+ Repository + Installation + Issues + Documentation + Releases +
+ {{ page.content | safe }} +{%- endblock main -%} From 013abd07254a80441ff6be1843c110a22e166283 Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Thu, 4 Apr 2024 10:41:04 +0200 Subject: [PATCH 2/2] Update content/diffutils.md Co-authored-by: Daniel Hofstetter --- content/diffutils.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/diffutils.md b/content/diffutils.md index b10527503..fbcc854d2 100644 --- a/content/diffutils.md +++ b/content/diffutils.md @@ -5,7 +5,7 @@ template = "project.html" +++ -Rust implementation of GNU diffutils: `diff`, `cmp` and `diff`. +Rust implementation of GNU diffutils: `diff`, `cmp`, `diff3` and `sdiff`. This project aims to be a drop-in replacement of the original commands.