This commit is contained in:
parent
481ff13992
commit
f567d2bcc3
GPG Key ID:
03789458B3D0C410
5
contrib/web/01-INTRO.md
Normal file
5
contrib/web/01-INTRO.md
Normal file
@ -0,0 +1,5 @@
|
||||
`distribusi` is handy when you have a bunch of files and folders on your
|
||||
computer and you want to publish them online without much fuss. It's a
|
||||
command-line tool which generates html pages for each directory. This website
|
||||
is made with `distribusi`! Have a stroll around. You can think of it as a
|
||||
low-tech content management tool for the web.
|
||||
7
contrib/web/02-FILES.md
Normal file
7
contrib/web/02-FILES.md
Normal file
@ -0,0 +1,7 @@
|
||||
`distribusi` tries to make standalone HTML files which are convenient for
|
||||
browsing on the web. It loads the content from text files directly into the
|
||||
page. The name of the file is included below ("02-FILES.md").
|
||||
|
||||
Each image is shown as a thumbnail which is automatically generated by
|
||||
`distribusi`. This makes the pages more lightweight. Thumbnails can be removed
|
||||
easily later on. See the <a href="/tutorial">tutorial</a> for more.
|
||||
BIN
contrib/web/heya.jpg
Normal file
BIN
contrib/web/heya.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 214 KiB |
BIN
contrib/web/heya_distribusi_thumbnail.jpg
Normal file
BIN
contrib/web/heya_distribusi_thumbnail.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
78
contrib/web/index.html
Normal file
78
contrib/web/index.html
Normal file
@ -0,0 +1,78 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated with distribusi-go -->
|
||||
<meta name='generator' content='distribusi-go' />
|
||||
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
|
||||
<style>
|
||||
.image {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.pdf {
|
||||
width: 640px;
|
||||
height: 640px;
|
||||
}
|
||||
|
||||
.x-directory::before {
|
||||
content: "📁 ";
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
.filename {
|
||||
display: block;
|
||||
font-family: mono;
|
||||
}
|
||||
|
||||
.gif {
|
||||
width: 450px;
|
||||
max-height: 450px;
|
||||
}
|
||||
|
||||
div {
|
||||
display: inline-block;
|
||||
vertical-align: top;
|
||||
margin: 1em;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
video {
|
||||
width: 450px;
|
||||
max-height: 450px;
|
||||
}
|
||||
|
||||
/* this is the stylesheet for this website 😌 */
|
||||
|
||||
html {
|
||||
background-color: #bde1fe;
|
||||
margin: 3rem;
|
||||
}
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div id="tutorial" class='x-directory'><a href='tutorial/'>tutorial/</a></div>
|
||||
<div id="01-INTRO.md" class='text'><pre>`distribusi` is handy when you have a bunch of files and folders on your
|
||||
computer and you want to publish them online without much fuss. It's a
|
||||
command-line tool which generates html pages for each directory. This website
|
||||
is made with `distribusi`! Have a stroll around. You can think of it as a
|
||||
low-tech content management tool for the web.</pre><span class='filename'>01-INTRO.md</span></div>
|
||||
<div id="02-FILES.md" class='text'><pre>`distribusi` tries to make standalone HTML files which are convenient for
|
||||
browsing on the web. It loads the content from text files directly into the
|
||||
page. The name of the file is included below ("02-FILES.md").
|
||||
|
||||
Each image is shown as a thumbnail which is automatically generated by
|
||||
`distribusi`. This makes the pages more lightweight. Thumbnails can be removed
|
||||
easily later on. See the <a href="/tutorial">tutorial</a> for more.</pre><span class='filename'>02-FILES.md</span></div>
|
||||
<div id="heya.jpg" class='image'><figure> <a href="heya.jpg"> <img class="thumbnail" loading="lazy" src="heya_distribusi_thumbnail.jpg"> </a> </figure><span class='filename'>heya.jpg</span></div>
|
||||
<div id="styles.css" class='text'><pre>/* this is the stylesheet for this website 😌 */
|
||||
|
||||
html {
|
||||
background-color: #bde1fe;
|
||||
margin: 3rem;
|
||||
}</pre><span class='filename'>styles.css</span></div>
|
||||
</body>
|
||||
</html
|
||||
66
contrib/web/tutorial/README.md
Normal file
66
contrib/web/tutorial/README.md
Normal file
@ -0,0 +1,66 @@
|
||||
## Install
|
||||
|
||||
Visit the following URL:
|
||||
|
||||
<a href="https://vvvvvvaria.org/~decentral1se/distribusi-go">vvvvvvaria.org/~decentral1se/distribusi-go</a>
|
||||
|
||||
You need to download the right binary for your system. `distribusi` aims to be
|
||||
portable and run on older hardware. Let us know if you need another os/arch
|
||||
supported!
|
||||
|
||||
If you're on good 'ol 64 bit linux, then that'll be:
|
||||
|
||||
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/alpha/distribusi_linux_amd64/distribusi -o distribusi
|
||||
chmod +x distribusi
|
||||
|
||||
The download size is currently ~ 1.8MB. You don't need to install anything else
|
||||
to use `distribusi`.
|
||||
|
||||
## Help
|
||||
|
||||
```
|
||||
distribusi -h
|
||||
USAGE:
|
||||
distribusi [options] [arguments]
|
||||
|
||||
DESCRIPTION:
|
||||
A low-tech content management system for the web that produces static index
|
||||
pages based on folders in the files system. It is inspired by the automatic
|
||||
index functions featured in several popular web servers.
|
||||
|
||||
ARGUMENTS:
|
||||
<path> path to distribusify (default: ".")
|
||||
|
||||
OPTIONS:
|
||||
-d show debug output
|
||||
-c css file for custom styles
|
||||
-h output help
|
||||
-i ignore paths (e.g. "*.gif")
|
||||
-s serve locally
|
||||
-v output version
|
||||
-w wipe generated files
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
||||
I usually run the following: `distribusi -s .` You'll see
|
||||
|
||||
distribusifying... live @ http://localhost:1312
|
||||
|
||||
`distribusi` will then try to generate files and serve them locally:
|
||||
|
||||
<a href="http://localhost:1312">localhost:1312</a>
|
||||
|
||||
If you have a lot of files, it could take some time to generate everything.
|
||||
When everything is ready, you'll see a "done!" appear in your terminal:
|
||||
|
||||
distribusifying... live @ http://localhost:1312 done!
|
||||
|
||||
If you're wondering what `distribusi` is doing, pass `-d` for debug output.
|
||||
|
||||
## Publishing
|
||||
|
||||
One "simple" option is to use `rsync` and transfer your files to your server.
|
||||
|
||||
distribusi .
|
||||
rsync -avz . varia.zone:public_html
|
||||
125
contrib/web/tutorial/index.html
Normal file
125
contrib/web/tutorial/index.html
Normal file
@ -0,0 +1,125 @@
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated with distribusi-go -->
|
||||
<meta name='generator' content='distribusi-go' />
|
||||
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8">
|
||||
|
||||
<style>
|
||||
.image {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.pdf {
|
||||
width: 640px;
|
||||
height: 640px;
|
||||
}
|
||||
|
||||
.x-directory::before {
|
||||
content: "📁 ";
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
.filename {
|
||||
display: block;
|
||||
font-family: mono;
|
||||
}
|
||||
|
||||
.gif {
|
||||
width: 450px;
|
||||
max-height: 450px;
|
||||
}
|
||||
|
||||
div {
|
||||
display: inline-block;
|
||||
vertical-align: top;
|
||||
margin: 1em;
|
||||
padding: 1em;
|
||||
}
|
||||
|
||||
video {
|
||||
width: 450px;
|
||||
max-height: 450px;
|
||||
}
|
||||
|
||||
/* this is the stylesheet for this website 😌 */
|
||||
|
||||
html {
|
||||
background-color: #bde1fe;
|
||||
margin: 3rem;
|
||||
}
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div id="menu" class='x-directory'><a href='../'>../</a></div>
|
||||
<div id="README.md" class='text'><pre>## Install
|
||||
|
||||
Visit the following URL:
|
||||
|
||||
<a href="https://vvvvvvaria.org/~decentral1se/distribusi-go">vvvvvvaria.org/~decentral1se/distribusi-go</a>
|
||||
|
||||
You need to download the right binary for your system. `distribusi` aims to be
|
||||
portable and run on older hardware. Let us know if you need another os/arch
|
||||
supported!
|
||||
|
||||
If you're on good 'ol 64 bit linux, then that'll be:
|
||||
|
||||
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/alpha/distribusi_linux_amd64/distribusi -o distribusi
|
||||
chmod +x distribusi
|
||||
|
||||
The download size is currently ~ 1.8MB. You don't need to install anything else
|
||||
to use `distribusi`.
|
||||
|
||||
## Help
|
||||
|
||||
```
|
||||
distribusi -h
|
||||
USAGE:
|
||||
distribusi [options] [arguments]
|
||||
|
||||
DESCRIPTION:
|
||||
A low-tech content management system for the web that produces static index
|
||||
pages based on folders in the files system. It is inspired by the automatic
|
||||
index functions featured in several popular web servers.
|
||||
|
||||
ARGUMENTS:
|
||||
<path> path to distribusify (default: ".")
|
||||
|
||||
OPTIONS:
|
||||
-d show debug output
|
||||
-c css file for custom styles
|
||||
-h output help
|
||||
-i ignore paths (e.g. "*.gif")
|
||||
-s serve locally
|
||||
-v output version
|
||||
-w wipe generated files
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
||||
I usually run the following: `distribusi -s .` You'll see
|
||||
|
||||
distribusifying... live @ http://localhost:1312
|
||||
|
||||
`distribusi` will then try to generate files and serve them locally:
|
||||
|
||||
<a href="http://localhost:1312">localhost:1312</a>
|
||||
|
||||
If you have a lot of files, it could take some time to generate everything.
|
||||
When everything is ready, you'll see a "done!" appear in your terminal:
|
||||
|
||||
distribusifying... live @ http://localhost:1312 done!
|
||||
|
||||
If you're wondering what `distribusi` is doing, pass `-d` for debug output.
|
||||
|
||||
## Publishing
|
||||
|
||||
One "simple" option is to use `rsync` and transfer your files to your server.
|
||||
|
||||
distribusi .
|
||||
rsync -avz . varia.zone:public_html</pre><span class='filename'>README.md</span></div>
|
||||
</body>
|
||||
</html
|
||||
Loading…
x
Reference in New Issue
Block a user