gfr
/
bloggy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

simplification

This commit is contained in:
gfr 2022-11-17 15:09:06 +00:00
parent 93e01a30b6
commit a191b79c29
1 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -3,8 +3,6 @@ a minimalist Markdown site maker for Caddy
![image](https://moth.monster/projects/bloggy/bloggy.png)
[docs](https://bloggy.moth.monster/)
try it locally:
```
@ -19,4 +17,37 @@ or
git clone https://git.disroot.org/gfr/bloggy/
cd bloggy
sudo caddy run
```
```
## installation
Bloggy relies on Caddy to function as its webserver. Feel free to reference Caddy's official documentation here: https://caddyserver.com/docs/install.
This guide also assumes that you already have DNS and port forwarding configured. If you don't know how to do that, check with your domain registrar, cloud provider, or ISP, as the steps can vary.
***
To begin, download Bloggy.
```
git clone https://github.com/mothdotmonster/bloggy bloggy
cd bloggy
```
If you want to simply try out Bloggy, you can use the given Caddyfile to test it out.
`sudo caddy run`
***
If you want to use Bloggy more permanently, a full installation is rather simple. Start by moving the downloaded files to a more permanent location. In this example, we will use /var/www.
```
sudo mv * /var/www/
cd /var/www
```
Next, you're going to need to edit the Caddyfile. Using your editor of choice. replace localhost with the domain your website will be on (for example, this website uses bloggy.moth.monster), and replace root * ./ with root * /var/www. Feel free to make any tweaks you'd like; these are just the minimum to get things working.
Finally, move the Caddyfile into the correct location for it to be used automatically, and restart the Caddy service.
```
mv Caddyfile /etc/caddy/Caddyfile
sudo systemctl reload caddy
```
If everything has been done correctly, your server will begin running with the sample pages.
## customization
For basic customization, all you need to do is edit some Markdown using your favorite text editor. To customize the index page, edit index.md
To add a new post, create a .md file in the markdown folder. It will automatically be added to the listing on the index page.
Formatting follows standard Markdown, a good reference for this is Markdown Guide. You can also embed any HTML you'd like.
For more advanced customization, you can edit index.html to further customize the index page, blog.html to customize the posts, and style.css to customize the stylesheet. All pages are generated based off these three files.