Add my changes

pull/1/head
Arya K 3 months ago
parent 6b541a2cb9
commit 414d8c07c9
Signed by: aryak
GPG Key ID: 3A6EA2D0EE314EEF
  1. 14
      _config.sh
  2. 8
      _footer.html
  3. 7
      _header.html
  4. 4
      makefile
  5. 88
      pages/index.md
  6. 97
      pages/tweaks.md
  7. 17
      pblog.sh
  8. 36
      posts/community-patch.md
  9. 34
      posts/default-styles.md
  10. 96
      posts/pblog-intro.md
  11. 11
      posts/pblog-launch.md
  12. 27
      posts/small-patch.md
  13. 16
      posts/welcome.md
  14. 4
      rss.xsl
  15. 96
      style.css

@ -2,21 +2,19 @@
# Site specific settings
###################################################################################
DOMAIN="https://pblog.xyz"
TITLE="pblog.xyz"
DESCRIPTION="Pandoc static blog generator"
COPYRIGHT="Copyright 2022, Bradley Taunt"
AUTHOR="hello@tdarb.org (Bradley Taunt)"
OS="BSD" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS)
DOMAIN="https://vern.cc"
TITLE="Blog | ~vern"
DESCRIPTION="The blog of ~vern"
COPYRIGHT="Copyright 2022, ~vern administrators"
AUTHOR="root@vern.cc (~vern administrators)"
OS="Linux" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS)
HTML_LANG="en_US" # Your document (HTML) language setting
# Blog structure settings (most users should use these defaults)
###################################################################################
TOC=true
SYNTAX=true
PAGES_DIR="pages/"
POSTS_DIR="posts/"
PAGES=$(find $PAGES_DIR -type f)
POSTS=$(find $POSTS_DIR -type f)
WEB_HTML="blog/"
OUTPUT="_output/"

@ -1,10 +1,4 @@
</article><!-- Do not remove this closing article element -->
<!-- Content placed here will appear directly before the closing </body> tag -->
<footer>
<br>
<hr>
<p><small>Powered by <a href="https://pblog.xyz">pblog</a><br>
Made with &hearts; for a simpler web.<br>
Peanut butter sandwich illustration by Kate Maldjian from NounProject.com</small></p>
</footer>
<!--#include file="/footer"-->

@ -1,9 +1,4 @@
<!-- Content placed here will appear directly after the opening <body> tag -->
<nav>
<a href="/">Home</a><span>&nbsp;/&nbsp;</span>
<a href="/blog">Blog</a><span>&nbsp;/&nbsp;</span>
<a href="/tweaks.html">Tweaks</a><span>&nbsp;/&nbsp;</span>
<a href="https://codeberg.org/tdarb/pblog">Download</a>
</nav>
<!--#include file="/nav" -->
<!-- Do not remove this opening article element -->
<article>

@ -2,8 +2,8 @@
.PHONY: build
build:
bash pblog.sh > _output/feed.xml
xsltproc _output/feed.xml > _output/blog/index.html
bash pblog.sh > _output/blog/feed.xml
xsltproc _output/blog/feed.xml > _output/blog/index.html
serve: build
python3 -m http.server --directory _output/

@ -1,88 +0,0 @@
---
title: pblog.xyz
toc: false
---
<img style="max-width:200px;" src="/media/pb-sandwich.svg" alt="Peanut butter sandwich">
## Pandoc static blog generator
`pblog` comes packed with an incredible list of features:
- 5-second configuration
- Write all your posts and pages in Markdown
- Valid RSS 2.0 feed (customized design too!)
and it also *doesn't* ship with a lot of other features:
- No advanced template layouts
- No themes
- No categories / tagging systems
- No comments
- No auto rebuilds for local testing
But you can add these things yourself with a little know-how and patience! The goal of `pblog` is to remain as bare-bones as possible, so these "extras" are left out intentionally.
## Live Demo
This very website is a live demo! Mind blowing, right? Take a look at the [automated blog list](/blog) to see some blog posts.
## Requirements
#### On MacOS / BSD Systems
- [rsync](https://linux.die.net/man/1/rsync)
- [coreutils](https://www.gnu.org/software/coreutils/)
- [xsltproc](http://xmlsoft.org/xslt/xsltproc.html)
- [Pandoc](https://pandoc.org/installing.html)
#### On Linux
- [rsync](https://linux.die.net/man/1/rsync)
- [xsltproc](http://xmlsoft.org/xslt/xsltproc.html)
- [Pandoc](https://pandoc.org/installing.html)
## Getting Started
1. Clone the project repo: [https://codeberg.org/tdarb/pblog](https://codeberg.org/tdarb/pblog)
2. Edit the variables at the top of the `pblog.sh` file
3. **!! Pay close attention to the `OS` variable to set your correct operating system !!**
4. Edit the posts in `posts` and pages in `pages` to your own
5. Run `make` from the root directory
6. Upload the contents of the `_output` folder to your server
7. Profit!!!
For a more in-depth look, take a look at the article [Introducing pblog](/blog/pblog-intro.html)
## Base Settings
#### Table of Contents
By default `pblog` ships with TOC (Table of Contents) enabled. You can disable this on each individual page or post by editing the `TOC `variable in `pblog.sh` to `false`:
```yaml
TOC: false
```
#### Code Highlighting
`pblog` uses the standard syntax highlighting provided with Pandoc. To disable this, set the `SYNTAX` variable to `false` in `pblog.sh`:
```yaml
SYNTAX: false
```
## Extras
- Add all media files (images, videos, etc.) under the `media` folder
- Customize the look of your blog by editing the included `style.css`
- Looking for fancier *image manipulation*? Take a look at [this detailed post to get setup](/tweaks.html)
## Sites built with pblog
- [tdarb.org](https://tdarb.org)
- [matthewgraybosch.com](https://matthewgraybosch.com)
You can share your **pblog** websites by emailing me at the address listed below and I'll add them here.
hello at tdarb {dot} org

@ -1,97 +0,0 @@
---
title: Tweaks
toc: true
---
## Tweaks Explained
"Tweaks" are extra features that are not packaged within the default `pblog` project. If you have your own tweaks you would like to include, be sure to [open a patch](https://git.sr.ht/~tdarb/pblog.xyz).
---
<br>
## Magick Images
#### by: [Matthew Graybosch](https://matthewgraybosch.com)
This tweak gives you the ability to automatically convert PNG and JPG images to WEBP and AVIF files when used with the `picture` HTML element.
**Requirements**:
- Download and install [ImageMagick](https://imagemagick.org/script/download.php)
Then change your base `makefile` to reflect the following:
```bash
.SUFFIXES: .png .jpg .webp .avif
.jpg.webp:
magick -quality 80 "$<" "$@"
.jpg.avif:
magick -quality 80 "$<" "$@"
.png.webp:
magick -quality 80 "$<" "$@"
.png.avif:
magick -quality 80 "$<" "$@"
JPEGS!=find media/ -name '*.jpg'
PNGS!=find media/ -name '*.png'
JPEG_WEBP=${JPEGS:.jpg=.webp}
JPEG_AVIF=${JPEGS:.jpg=.avif}
PNG_WEBP=${PNGS:.png=.webp}
PNG_AVIF=${PNGS:.png=.avif}
.DEFAULT: build
.PHONY: build
build: $(JPEG_WEBP) $(JPEG_AVIF) $(PNG_WEBP) $(PNG_AVIF)
bash pblog.sh > _output/feed.xml
xsltproc _output/feed.xml | tail -n +2 > _output/blog/index.html
serve: build
python3 -m http.server --directory _output/
clean:
rm _output/* rss/* $(JPEG_WEBP) $(JPEG_AVIF) $(PNG_WEBP) $(PNG_AVIF)
```
That's it. Enjoy!
---
<br>
## Hiding Table of Contents "Heading"
#### by [Bradley Taunt](https://tdarb.org)
By default the include *Table of Contents* displays a title and styled section. To disable this, simply edit the `style.css` file and comment out or delete the following:
```css
#TOC {
border: 1px solid;
position: relative;
}
#TOC:before {
border-bottom: 1px solid;
content: 'Table of Contents';
display: block;
font-weight: bold;
padding: 5px;
position: relative;
}
```
---
<br>
## Adding navigation to blog index and RSS feed
In order to include any main navigation (or other custom elements for that matter) on the main blog index page and RSS `feed.xml`, simply edit the `rss.xml` file in the root directory. Be sure to add your elements / content inside the `body` tag near the bottom of the page.

@ -30,29 +30,24 @@ for i in $POSTS; do pandoc --css=../style.css --ascii --metadata lang="$HTML_LAN
rsync $POSTS_DIR*.html $OUTPUT$WEB_HTML;
rm $POSTS_DIR*.html
# Create the web browser-focused HTML versions for all pages
for i in $PAGES; do pandoc --css=style.css --ascii --metadata lang="$HTML_LANG" $TOC_TOGGLE $SYNTAX_TOGGLE --wrap=none -A _footer.html -B _header.html -s $i -o ${i%.*}.html; done;
rsync $PAGES_DIR*.html $OUTPUT;
rm $PAGES_DIR*.html
# Copy XSLT, stylesheet, and media files
rsync rss.xsl $OUTPUT;
rsync style.css $OUTPUT;
rsync -r media $OUTPUT;
rsync rss.xsl $OUTPUT/blog;
rsync style.css $OUTPUT/blog;
rsync -r media $OUTPUT/blog;
# Remove the default blog index to avoid pulling into the XML feed
rm $OUTPUT$WEB_HTML/index.html
echo "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<?xml-stylesheet href=\"rss.xsl\" type=\"text/xsl\"?>
<rss version=\"2.0\">
<rss version=\"2.0\" xmlns:atom=\"http://www.w3.org/2005/Atom\">
<channel>
<title>$TITLE</title>
<link>$DOMAIN</link>
<description>$DESCRIPTION</description>
<copyright>$COPYRIGHT</copyright>
<ttl>$TTL</ttl>";
<ttl>$TTL</ttl>
<atom:link href=\"https://vern.cc/blog/feed.xml\" rel=\"self\" type=\"application/rss+xml\" />";
for file in $OUTPUT$WEB_HTML*; do

@ -1,36 +0,0 @@
---
title: 'First Community Patch & "Tweaks"'
date: Fri, 15 Jul 2022
---
`pblog` has received its first community patch! By "community" I mean someone other than myself has helped make this blog generator even better. So special thanks to [Matthew Graybosch](https://matthewgraybosch.com/) for contributing to this humble project and patching in some solid quality of life improvements.
This is why open source is great: smarter people can help fix your mashed-up spaghetti code!
### The Changes
1. Both pages and posts now generated *Table of Contents* by default
- You have the ability to disable this site-wide in the `pblog` config
2. Ability to disable Pandoc generated syntax highlighting
3. `xsltproc` will now generate HTML5 and include the RSS feed description under the title
- See it live on the [main RSS XML feed](/feed.xml)
4. New metadata variable (`HTML_LANG`) in the `pblog.sh` config
5. Generated pages and posts now have "Table of Contents" by default
- This can be disabled in individual files with `toc: false`
6. Cleaned up redundant find statements
### Some Features Left Behind...
Also suggested in this patch was the addition of more advanced image manipulation via `ImageMagick`. This additional feature was pretty great from my testing but I felt as though adding an extra dependency and *slightly* more complex settings to `pblog` was moving things further from simplicity.
**BUT** - that doesn't mean you can't take this great feature with you!
### Introducing "Tweaks"
I feel that `pblog` should always remain as simple as possible at the core. Let people get something up-and-running with the least amount of friction as possible. But I know that some users might want to squeeze just a *little* bit more out of it. This is where the new **Tweaks** section comes in.
Feel free to check out the [official Tweaks page](/tweaks.html) and don't be afraid to add your own by opening a patch-set!
That's all for now, thanks for reading!
-- Brad

@ -1,34 +0,0 @@
---
title: New Default Styling and 2x Faster!
date: Wed, 27 Jul 2022
---
If it wasn't already obvious, this project has received a minor styling overhaul. But looks weren't the only thing updated with this latest patch.
The total build process time is now *two times faster*!
Keep reading for more details.
## The Default "Theme"
The styling changes aren't anything ground breaking. They simply center the main content and add a little more visual separation of the content and backdrop. Again, you can customize `pblog` as you see fit, but having a sane default is always nice.
## New Config Setup
Since updates and performance fixes might continue to come through in the future, I didn't want to make users play around with their default configuration every single time. Now, all main configuration is handled in the new `_config.sh` file.
Feels cleaner already, right?
## Cutting the Build Time in Half
I must give big kudos to [Matthew Graybosch](https://matthewgraybosch.com) for inspiring this pretty big improvement. After some discussion over emails we both agreed that it seemed overkill to render the blog content twice (once for the XML feed itself and then again for all posts listed under `blog`). Performance wasn't the initial goal when I first launched this project, but now that the dust has settled it seemed appropriate to go back and fix some things.
`pblog` now only needs to render the blog posts found in the `posts` directory *once*. It still produces semantic XML and keeps the webview versions of the articles looking solid. Overall I'm pretty happy with this *little* improvement - it should pretty noticeable on projects rendering many posts.
## Far From Perfect
This project is still very much in it's infancy. So if you notice something odd or broken in your own testing, please don't hesitate to open a patch or simply bring up the issue!
Thanks for reading,
-- Brad

@ -1,96 +0,0 @@
---
title: Introducing pblog
date: Mon, 04 Jul 2022
---
This article is a *living document*. It will always have the most up-to-date information on getting started with `pblog`.
**Last Updated**: July 27, 2022
---
Although this project was already [announced](/blog/pblog-launch.html) a couple days ago, I thought it might be best to actually breakdown `pblog` into greater detail.
Enough chit-chat, let's get into it!
### Main Goal
The entire purpose of `pblog` is to be as bare-bones as possible, while still maintaining a pleasant writing workflow. Users write their posts and pages in Markdown - *pblog* handles everything else:
- Posts and pages generated via Pandoc with minimal CSS
- RSS feed at `feed.xml`
- Generated blog listing at `blog/index.html`
- Browser-styled XML (in supported browsers)
### Site Structure
After you've cloned the [official pblog repo on Codeberg](https://codeberg.org/tdarb/pblog), the next thing you should do is edit the main `_config.sh` file in the root directory. This will give you a better understanding of how everything is built.
Once generated, *pblog* structures the final website files as such:
```shell
_output/
|__blog/
|__index.html
|__blog-post-example.html
|__media/
|__feed.xml
|__index.html
|__rss.xsl
|__style.css
```
This structure is completely customizable by simply editing the `pblog.sh` file (if you so desire).
### Headers and Footers
By default `pblog` will add the header and footer includes to every individual post and page. To edit these, simply open the `_header.html` and `_footer.html` files respectively.
**Important**: To avoid rendering issues DO NOT remove the included `article` opening and closing tags within those files. Everything else you can edit, remove, etc.
### Posts and Pages
Posts and pages are written via Markdown inside the `posts` and `pages` folders respectively.
Individual posts require the following headers (take note of the date format):
```yaml
---
title: Blog Title
date: Mon, 04 Jul 2022
---
```
while individual pages only require a `title`:
```yaml
---
title: Page Title
---
```
This makes for an easier switch over from other SSG platforms like Jekyll or Hugo.
### The Build Process
The main variables at the top of the `pblog.sh` file need to edited with your own details before generating your website. Those variables are fairly self-explanatory and simple to edit.
All you need to do now is run `make` (or `make serve` if you're looking to test locally) and you're done. Your website should now be fully generated inside the include `_output` directory. For quick reference:
1. *pblog* converts your Markdown posts into two variations of HTML
- One is used specifically for rendering itself inside the RSS feed
- The other is used for linking in a browser
2. Next, *pblog* converts your Markdown pages into HTML
3. All of these generated HTML files are then moved to the `_output` folder
*pblog* is also smart enough to automatically generate a main blog list directory for you. This `index.html` file is placed inside the `_output/blog` folder on build. You can see an example of the blog list [on this very website](/blog).
### Uploading to the WWW
Those with more experience will probably lean towards using a utility like `rsync` to sync the contents of their `_output` folder with their web server. For those with less experience, I recommend using something like [Netlify Drop](https://app.netlify.com/drop) to make things as friction-less as possible.
### Wrapping Up
There isn't much else to say. `pblog` is as static or flexible as you chose it to be. If you have any ideas on how to improve things or come across any bugs, please [open a ticket or PR on the official repo](https://codeberg.org/tdarb/pblog).
Thanks and happy blogging with *pblog*!

@ -1,11 +0,0 @@
---
title: Announcing pblog
date: Thu, 30 Jun 2022
---
It's time to celebrate! The official launch of `pblog` happened today.
There isn't much else to say. All details and instructions on how to start your own pblog can be found on the [main homepage for this project](https://pblog.xyz).
Thanks for reading!

@ -1,27 +0,0 @@
---
title: Includes, rsync and Variables - Oh My!
date: Fri, 08 Jul 2022
---
Even though `pblog` was just launched a week ago, it has since been updated with some nice quality-of-life improvements.
### Default "header" &amp; "footer" Includes
A new variable was added to the main `pblog.sh` configuration file called `INC_HEAD_FOOT`. By default this is set to `true` and simply pulls in two HTML files:
- `_header.html`: all content within is placed directly after the opening `body` tag
- `_footer.html`: all content within is placed directly before the closing `body` tag
These includes are added to every outputted file from inside both the `posts` and `pages` directories on build.
### Syncing Changes with rsync
Although it adds another dependency to the project, I believe utilizing `rsync` for the generated files is far better then nuking the directory from orbit each time. This also provides a cleaner experience for users syncing their `_output` directory with their web server of choice.
### On the Horizon...
My plan was to also tackle the issue of "auto rebuilds" when running `pblog` locally. This became more of a headache than I initially estimated - so it was dropped from this patch. My hope is to get something up-and-running in the near future, while avoiding the inclusion of yet another major dependency. Anyone more experienced than myself in the ways of "auto rebuilds" is free to open a patch if they so desire!
Thanks for your interest in these minor updates!
P.S. Don't forget - if your website runs on `pblog` be sure to reach out and get it featured on the [homepage](/)!

@ -0,0 +1,16 @@
---
title: Welcome to the new ~vern blog
date: Thu, 08 Sep 2022
---
Hi,
We have recently created a new blog for ~vern.
You can expect articles about ~vern, its services etc. but also about general articles about other UNIX/LibreSW related stuff!
Of course, if you would like to help with this, you can get the source on http://git.vern.cc/vern/blog
Regards,
~aryak

@ -14,7 +14,7 @@
</meta>
<meta http-equiv="x-ua-compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" />
<link rel="stylesheet" href="../style.css" />
<link rel="stylesheet" href="../../style.css" />
<style>
header {
border-bottom: 1px solid lightgrey;
@ -63,4 +63,4 @@
</html>
</xsl:template>
</xsl:stylesheet>
</xsl:stylesheet>

@ -1,14 +1,95 @@
/* latin-ext */
@font-face {
font-family: 'Fira Code';
font-style: normal;
font-weight: 400;
src: url(/woff2/FiraCodeLatinExt.woff2) format('woff2');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Fira Code';
font-style: normal;
font-weight: 400;
src: url(/woff2/FiraCodeLatin.woff2) format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
html {
background:#f9f9f9;
background:#282c34;
}
body {
background: #fff;
border: 1px solid lightgrey;
margin: 1em auto;
max-width: 75ch;
padding: 10px;
line-height: 1.4;
font-family:'Fira Code';
margin:20px auto;
max-width:800px;
line-height:1.5em;
font-size:1.1em;
background-color:#282c34;
color:#bbc2cf;
padding:0 10px;
hyphens:auto;
}
nav {
display:inline-block;
}
nav li {
display:inline-block no;
margin-right:20px;
}
.navlogo {
width:50px;
height:50px;
}
a {
color:#ff6c6b;
text-decoration:none;
}
a:hover {
color:#ff6c6b;
text-decoration:underline;
}
h1, h2, h3 {
display:inline;
line-height:1.2;
color:#51afef;
font-size:1.3em;
}
h2 {
font-size:1.2em;
}
h3 {
font-size:1.1em;
}
.h:hover a[aria-hidden] {
display:inline;
color:#ff6c6b;
size:75%;
}
.h a[aria-hidden] {
display:none;
}
pre {
tab-size:4;
}
.red {
color:#ff6c6b;
}
.green {
color:#98be65;
}
p code, li code {
@ -27,6 +108,7 @@ pre {
background: #f9f9f9;
border: 1px solid lightgrey;
padding: 5px;
tab-size:4;
}
#TOC {

Loading…
Cancel
Save