Automatic mdBook Documentation #2897
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| book | ||
| src/utils |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| [book] | ||
| authors = ["uutils contributors"] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "src" | ||
| title = "uutils Documentation" | ||
|
|
||
| [output.html] | ||
| git-repository-url = "https:/rust-lang/cargo/tree/master/src/doc/src" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Simple script to create the correct SUMMARY.md and other files | ||
| # for the mdbook documentation. | ||
| # Note: This will overwrite the existing files! | ||
|
|
||
| import os | ||
|
|
||
| with open('src/SUMMARY.md', 'w') as summary: | ||
| summary.write("# Summary\n\n") | ||
| summary.write("[Introduction](index.md)\n") | ||
| summary.write("* [Contributing](contributing.md)\n") | ||
| for d in sorted(os.listdir('../src/uu')): | ||
| summary.write(f"* [{d}](utils/{d}.md)\n") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # Summary | ||
|
|
||
| [Introduction](index.md) | ||
| * [Installation](installation.md) | ||
| * [Contributing](contributing.md) | ||
|
|
||
| # Reference | ||
| * [Multi-call binary](multicall.md) | ||
| * [arch](utils/arch.md) | ||
| * [base32](utils/base32.md) | ||
| * [base64](utils/base64.md) | ||
| * [basename](utils/basename.md) | ||
| * [basenc](utils/basenc.md) | ||
| * [cat](utils/cat.md) | ||
| * [chcon](utils/chcon.md) | ||
| * [chgrp](utils/chgrp.md) | ||
| * [chmod](utils/chmod.md) | ||
| * [chown](utils/chown.md) | ||
| * [chroot](utils/chroot.md) | ||
| * [cksum](utils/cksum.md) | ||
| * [comm](utils/comm.md) | ||
| * [cp](utils/cp.md) | ||
| * [csplit](utils/csplit.md) | ||
| * [cut](utils/cut.md) | ||
| * [date](utils/date.md) | ||
| * [dd](utils/dd.md) | ||
| * [df](utils/df.md) | ||
| * [dircolors](utils/dircolors.md) | ||
| * [dirname](utils/dirname.md) | ||
| * [du](utils/du.md) | ||
| * [echo](utils/echo.md) | ||
| * [env](utils/env.md) | ||
| * [expand](utils/expand.md) | ||
| * [expr](utils/expr.md) | ||
| * [factor](utils/factor.md) | ||
| * [false](utils/false.md) | ||
| * [fmt](utils/fmt.md) | ||
| * [fold](utils/fold.md) | ||
| * [groups](utils/groups.md) | ||
| * [hashsum](utils/hashsum.md) | ||
| * [head](utils/head.md) | ||
| * [hostid](utils/hostid.md) | ||
| * [hostname](utils/hostname.md) | ||
| * [id](utils/id.md) | ||
| * [install](utils/install.md) | ||
| * [join](utils/join.md) | ||
| * [kill](utils/kill.md) | ||
| * [link](utils/link.md) | ||
| * [ln](utils/ln.md) | ||
| * [logname](utils/logname.md) | ||
| * [ls](utils/ls.md) | ||
| * [mkdir](utils/mkdir.md) | ||
| * [mkfifo](utils/mkfifo.md) | ||
| * [mknod](utils/mknod.md) | ||
| * [mktemp](utils/mktemp.md) | ||
| * [more](utils/more.md) | ||
| * [mv](utils/mv.md) | ||
| * [nice](utils/nice.md) | ||
| * [nl](utils/nl.md) | ||
| * [nohup](utils/nohup.md) | ||
| * [nproc](utils/nproc.md) | ||
| * [numfmt](utils/numfmt.md) | ||
| * [od](utils/od.md) | ||
| * [paste](utils/paste.md) | ||
| * [pathchk](utils/pathchk.md) | ||
| * [pinky](utils/pinky.md) | ||
| * [pr](utils/pr.md) | ||
| * [printenv](utils/printenv.md) | ||
| * [printf](utils/printf.md) | ||
| * [ptx](utils/ptx.md) | ||
| * [pwd](utils/pwd.md) | ||
| * [readlink](utils/readlink.md) | ||
| * [realpath](utils/realpath.md) | ||
| * [relpath](utils/relpath.md) | ||
| * [rm](utils/rm.md) | ||
| * [rmdir](utils/rmdir.md) | ||
| * [runcon](utils/runcon.md) | ||
| * [seq](utils/seq.md) | ||
| * [shred](utils/shred.md) | ||
| * [shuf](utils/shuf.md) | ||
| * [sleep](utils/sleep.md) | ||
| * [sort](utils/sort.md) | ||
| * [split](utils/split.md) | ||
| * [stat](utils/stat.md) | ||
| * [stdbuf](utils/stdbuf.md) | ||
| * [sum](utils/sum.md) | ||
| * [sync](utils/sync.md) | ||
| * [tac](utils/tac.md) | ||
| * [tail](utils/tail.md) | ||
| * [tee](utils/tee.md) | ||
| * [test](utils/test.md) | ||
| * [timeout](utils/timeout.md) | ||
| * [touch](utils/touch.md) | ||
| * [tr](utils/tr.md) | ||
| * [true](utils/true.md) | ||
| * [truncate](utils/truncate.md) | ||
| * [tsort](utils/tsort.md) | ||
| * [tty](utils/tty.md) | ||
| * [uname](utils/uname.md) | ||
| * [unexpand](utils/unexpand.md) | ||
| * [uniq](utils/uniq.md) | ||
| * [unlink](utils/unlink.md) | ||
| * [uptime](utils/uptime.md) | ||
| * [users](utils/users.md) | ||
| * [wc](utils/wc.md) | ||
| * [who](utils/who.md) | ||
| * [whoami](utils/whoami.md) | ||
| * [yes](utils/yes.md) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{ #include ../../CONTRIBUTING.md }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,20 @@ | ||||||
| # 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. | ||||||
|
|
||||||
| The API reference for `uucore`, the library of functions shared between | ||||||
| various utils, is hosted at at | ||||||
| [docs.rs](https://docs.rs/uucore/0.0.12/uucore/). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| uutils is licensed under the [MIT License](https:/uutils/coreutils/LICENSE.md). | ||||||
|
|
||||||
| ## Useful links | ||||||
| * [Releases](https:/uutils/coreutils/releases) | ||||||
| * [Source Code](https:/uutils/coreutils) | ||||||
| * [Issues](https:/uutils/coreutils/issues) | ||||||
| * [Discord](https://discord.gg/wQVJbvJ) | ||||||
|
|
||||||
| > Note: This manual is automatically generated from the source code and is | ||||||
| > a work in progress. | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this list could be generated too, no ? :)
sorry to be a pain but i hate long static list :)