jasm1nii
/
xml-feed-generator
mirror of https://github.com/jasm1nii/xml-feed-generator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Jasmine Amalia 2023-10-18 14:03:14 +07:00 committed by GitHub
parent 9069618c86
commit eee6415633
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -4,28 +4,36 @@ an RSS/atom feed generator for my personal site :cat:
---
## disclaimer
### this script is not meant to be used as is.
expect to do *a lot* of modification to fit your needs, as this was created specifically for my site structure and blog markup.
**this script is not meant to be used as is (yet).**
expect to do *a lot* of modification to fit your needs, as this was originally tailored for my site structure and blog markup.
---
## how it basically works
## how it works
1. match files in a specificied directory.
2. load the DOM of each file.
3. parse values retrieved from the following strings/HTML elements, as children of a feed `<entry>`:
- `<h2>` as `<title>`
- the `datetime` attribute of `<time>` as `<updated>`
3. parse values retrieved from the following strings/HTML elements (prioritizing [h-entry markup](https://microformats.org/wiki/h-entry)), as children of a feed `<entry>`:
- `<element class=p-name>` (or `<h2>`) as `<title>`
- the `datetime` attribute of `<time>` (or the file creation date) as `<updated>`
- `<element class="p-summary">` as `<summary>`
- `<element class="e-content">` (or `<element class="entry"` for older markup) as `<content>`
- `/path/to/blog/entry` as `<id>`/`<link>`
4. output all of the above in a new file (named `articles.xml`).
- `<element class="e-content">` (or `<article>`) as `<content>`
- `/path/to/blog/entry` as `<id>` and `<link>`
4. output all of the above into a new file named **articles.xml**.
## ways to use
- configure a cron job on your web server to run automatically every now and then.
- if you manage your site with cPanel, [here's how to do that](https://docs.cpanel.net/cpanel/advanced/cron-jobs/).
or
- run the script locally on your machine.
- you can open the file on a local server like [five server](https://marketplace.visualstudio.com/items?itemName=yandeu.five-server) for vscode or [XAMPP](https://www.apachefriends.org/index.html).
---
## usage
configure a cron job on your server to run this script automatically every now and then, and voila~
---
## reference
## example output
feel free to check out [the resulting file](https://jasm1nii.xyz/blog/articles/articles.xml) that i've generated.
## alternatives
- [cjwainwright/FeedGenerator](https://github.com/cjwainwright/FeedGenerator)