From 12bc8ef9bb709ebd7536dbe97972390edf61cb31 Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Fri, 5 Nov 2021 15:47:46 +0100 Subject: [PATCH] docs: v2.2.0 --- docs/content/assets/style.css | 9 +++++++++ docs/content/configuration/command-line-arguments.md | 2 +- docs/content/download-and-install.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++--------------------- docs/content/getting-started.md | 19 ++++++++++++------- docs/mkdocs.yml | 2 ++ 5 files changed, 74 insertions(+), 29 deletions(-) create mode 100644 docs/content/assets/style.css diff --git a/docs/content/assets/style.css b/docs/content/assets/style.css new file mode 100644 index 0000000..8c1b682 --- /dev/null +++ b/docs/content/assets/style.css @@ -0,0 +1,9 @@ +.md-button.md-button-sm { + min-width: 7.5rem; + text-align: center; + margin-bottom: 0.5em; + padding: 0.2em 0.4em; +} +.featured-downloads { + text-align: center; +} diff --git a/docs/content/configuration/command-line-arguments.md b/docs/content/configuration/command-line-arguments.md index 3815b2b..08c37f4 100644 --- a/docs/content/configuration/command-line-arguments.md +++ b/docs/content/configuration/command-line-arguments.md @@ -10,7 +10,7 @@ The server can be configured via the following command-line arguments. ``` $ static-web-server -h -static-web-server 2.1.0 +static-web-server 2.2.0 Jose Quintana A blazing fast and asynchronous web server for static files-serving. diff --git a/docs/content/download-and-install.md b/docs/content/download-and-install.md index 959a8de..5ec6f82 100644 --- a/docs/content/download-and-install.md +++ b/docs/content/download-and-install.md @@ -1,26 +1,55 @@ # Download and Install -Latest featured downloads +Latest **v2.2.0** release `2021-11-04` ([changelog](https://github.com/joseluisq/static-web-server/releases/tag/v2.2.0)) -[Linux x86_64](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-unknown-linux-gnu.tar.gz){ .md-button } [macOS x86_64](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-apple-darwin.tar.gz){ .md-button } [Windows x86_64](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-pc-windows-msvc.zip){ .md-button } +
-See all [available releases](https://github.com/joseluisq/static-web-server/releases). +Linux 64-bit macOS 64-bit +Windows 64-bit +FreeBSD 64-bit + +
+ +## x86_64 + +- [static-web-server-v2.2.0-x86_64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-apple-darwin.tar.gz)
+**SHA256SUM:** `6bd02e090001fe5ab44a4f2377e3104038a43f4ee64bf5c6a1bd9f58e95c8e83` +- [static-web-server-v2.2.0-x86_64-pc-windows-gnu.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-pc-windows-gnu.zip)
+**SHA256SUM:** `80ca49393e59175d9ec6d7a380601e132f7ecc9c8562fbd82c0edda1d2bccc5b` +- [static-web-server-v2.2.0-x86_64-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-pc-windows-msvc.zip)
+**SHA256SUM:** `ebf49e2c75f4c35d59094cfc3b33d2b880bb830d365847093df0c77a4029cd39` +- [static-web-server-v2.2.0-x86_64-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-unknown-freebsd.tar.gz)
+**SHA256SUM:** `5e5ac568bf0df594cd27b9bbd0b4d23ff55cd28c59b7506740c558d995eddde7` +- [static-web-server-v2.2.0-x86_64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `143e5ce956c1238ae0354f7e26f39bb8d26eda1eedb2a007daf0a160790f0c67` +- [static-web-server-v2.2.0-x86_64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-x86_64-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `3e57b0eafe13920a7e50274a264aa1a36a122765673da72000aaabdd9a9b93ea` + +## ARM64 + +- [static-web-server-v2.2.0-aarch64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-aarch64-apple-darwin.tar.gz)
+**SHA256SUM:** `bf67da30824b2b2fa516a74f499516d10229e7dd96444039dc3c24c291f5a025` +- [static-web-server-v2.2.0-aarch64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-aarch64-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `1f9dd3358255bb9b8658e6c6de11246a50f5b7a6b4c9d4bda17cd2eb9fcb59b2` +- [static-web-server-v2.2.0-aarch64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-aarch64-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `297b170418b024a49a830c7cac69367fea63e5658165b057af5e9b876cd043bd` -### v2.1.0 - 2021-10-23 - -See [v2.1.0 release history](https://github.com/joseluisq/static-web-server/releases/tag/v2.1.0). - -- [static-web-server-v2.1.0-aarch64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-aarch64-apple-darwin.tar.gz)
`076b7e801a3252ccee9391d94a517bf9d70e29d1b93c744c9ea7d9fa3ffc63fb` -- [static-web-server-v2.1.0-aarch64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-aarch64-unknown-linux-gnu.tar.gz)
`7efd6f5b4db3cd7fc423d3d3a7c68f1b86411449f2a2030aeb19aea857db9f5e` -- [static-web-server-v2.1.0-aarch64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-aarch64-unknown-linux-musl.tar.gz)
`5888d772b0ecf93d87eb39def45c5b09d7ac2fc8a236d6e65fd46035b5ed4afb` -- [static-web-server-v2.1.0-arm-unknown-linux-gnueabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-arm-unknown-linux-gnueabihf.tar.gz)
`cde040c48d7032c1a6d9f7990322112c3f423ed4b527c77d10b9d71a32246351` -- [static-web-server-v2.1.0-i686-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-i686-pc-windows-msvc.zip)
`4b85b8615627087720bc719e37d8b5efb7d5260caeb30b38598064675fba0227` -- [static-web-server-v2.1.0-i686-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-i686-unknown-freebsd.tar.gz)
`1e147aa1dd7a22ba7b9b829f60d6dc4bec20c4ff42e3ec147898d01774c88fd3` -- [static-web-server-v2.1.0-i686-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-i686-unknown-linux-gnu.tar.gz)
`c113dfa00f04c2b6f2a1e8f1700c0710dc0a6a430d7e2a7e5f10bd1d29af5a84` -- [static-web-server-v2.1.0-i686-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-i686-unknown-linux-musl.tar.gz)
`d6070951586785a87cc340aca64cb2df13f41f94ab3d0f7bacfbfdc7efbb8d53` -- [static-web-server-v2.1.0-x86_64-apple-darwin.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-apple-darwin.tar.gz)
`55ded256c9a1698ab2532d30af29b7329dd2d3c5fb073a268e4cc75dff415b74` -- [static-web-server-v2.1.0-x86_64-pc-windows-gnu.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-pc-windows-gnu.zip)
`51a3dc66a346e60825636e9f29941ebd6bed1b57111b05704f3fffd9340e7a98` -- [static-web-server-v2.1.0-x86_64-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-pc-windows-msvc.zip)
`d34ac9f47e5a3f3f48c79500dcb1c80993871ab3f8e4a328ebd7ee6929ae7679` -- [static-web-server-v2.1.0-x86_64-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-unknown-freebsd.tar.gz)
`4e7a444d314c7ea807a3731485db17e6f130285f39633f566349b51b78d3ede5` -- [static-web-server-v2.1.0-x86_64-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-unknown-linux-gnu.tar.gz)
`c39445deacef14e9e39df24235d22d9936c62cf1e1490e9c4f352b0563db9db7` -- [static-web-server-v2.1.0-x86_64-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.1.0/static-web-server-v2.1.0-x86_64-unknown-linux-musl.tar.gz)
`de3b0b438ed348d422e3d118863da8d20a8b395fb4af59721f50057cc82cd126` +## x86 + +- [static-web-server-v2.2.0-i686-pc-windows-msvc.zip](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-i686-pc-windows-msvc.zip)
+**SHA256SUM:** `5de6f543110bf8e67b9af82fc708ac8e1480d681b0f3b3394ad0ae3a6bfff61c` +- [static-web-server-v2.2.0-i686-unknown-freebsd.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-i686-unknown-freebsd.tar.gz)
+**SHA256SUM:** `b74d30ae743f951fdb3cfd68d67374ca9edf7f6af7fe5827b6ef17e1894acdad` +- [static-web-server-v2.2.0-i686-unknown-linux-gnu.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-i686-unknown-linux-gnu.tar.gz)
+**SHA256SUM:** `a055439da5786509625b92785705edefd6cea2de69f97a9305b07d15fac1b1a1` +- [static-web-server-v2.2.0-i686-unknown-linux-musl.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-i686-unknown-linux-musl.tar.gz)
+**SHA256SUM:** `da9b4aeb719ef81de1093b7ac75577ac2b2a32fbf41671271027fd29052cb2a2` + +## ARM + +- [static-web-server-v2.2.0-arm-unknown-linux-gnueabihf.tar.gz](https://github.com/joseluisq/static-web-server/releases/download/v2.2.0/static-web-server-v2.2.0-arm-unknown-linux-gnueabihf.tar.gz)
+**SHA256SUM:** `9d4d562502371f136437cb30611989b8e539ea46eaf050ba071afea3a5e898ad` + +## All Releases + +See all [available releases](https://github.com/joseluisq/static-web-server/releases). diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md index 93b27c2..ab057f6 100644 --- a/docs/content/getting-started.md +++ b/docs/content/getting-started.md @@ -1,15 +1,20 @@ # Getting Started -First [download](./download-and-install.md) the binary for your platform. +[Download](./download-and-install.md) the binary for your platform and then just type -Then just type the following command. +```sh +static-web-server --port 8787 --root ./my-public-dir +``` + +Or if you use [Docker](https://www.docker.com/) just try ```sh -static-web-server \ - --port 8787 \ - --root ./my-public-dir +docker run --rm -it -p 8787:80 joseluisq/static-web-server:2 ``` -For details about the available options type `static-web-server -h` or go to the [Command-line arguments](./configuration/command-line-arguments.md) section. +!!! info "Docker Tip" + You can specify the Docker volume like `-v $HOME/my-public-dir:/public` in order to overwrite the default root directory. See [Docker examples](examples/docker.md) for more details. + +For more details about the available options type `static-web-server -h` or go to the [Command-line arguments](./configuration/command-line-arguments.md) section. -Or if you are looking fo more advanced examples then take a look at [the examples](./examples/http1.md) section. +Or if you are looking fo more advanced examples then have a look at [the examples](./examples/http1.md) section. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index eb27eb1..83eaa52 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,6 +12,8 @@ edit_uri: edit/master/docs/content/ docs_dir: 'content' site_dir: '/tmp/docs' +extra_css: + - 'assets/style.css' # Copyright copyright: Copyright © 2019-2021 Jose Quintana -- libgit2 1.7.2