Skip to content

Remove oranda in favour of zola pages #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
24 changes: 24 additions & 0 deletions content/coreutils.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions content/diffutils.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions content/findutils.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 20 additions & 4 deletions static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -340,7 +340,7 @@ footer {

.title {
font-size: 3em;
font-weight: bold;
font-weight: 900;
margin-bottom: 0.5em;
}

Expand Down Expand Up @@ -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;
}
18 changes: 18 additions & 0 deletions templates/project.html
Original file line number Diff line number Diff line change
@@ -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 -%}
Loading