Merge pull request #34 from uutils/remove-oranda

tertsdiepraam · web-flow · commit 24349a40d2e3 · 2024-04-04T10:48:07.000+02:00
Remove oranda in favour of zola pages
diff --git 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
@@ -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
@@ -0,0 +1,16 @@
++++
+
+title = "diffutils"
+template = "project.html"
+
++++
+
+Rust implementation of GNU diffutils: `diff`, `cmp`, `diff3` and `sdiff`.
+
+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
@@ -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
@@ -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;
-}
+}
+
+.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
@@ -0,0 +1,18 @@
+{%- extends "base.html" -%}
+
+{%- block title -%}
+    {{ page.title }} | uutils
+{%- endblock title -%}
+
+{%- block main -%}
+    <div class="title">{{ page.title }}</div>
+
+    <div class="links">
+        <a href="https://github.com/uutils/{{page.title}}">Repository</a>
+        <a href="/{{page.title}}/docs/installation.html">Installation</a>
+        <a href="https://github.com/uutils/{{page.title}}/issues">Issues</a>
+        <a href="/{{page.title}}/docs">Documentation</a>
+        <a href="https://github.com/uutils/{{page.title}}/releases">Releases</a>
+    </div>
+    {{ page.content | safe }}
+{%- endblock main -%}
