https://github.com/traceypooh/blogtini
Markdown + JS 100% client-side blogs & websites
https://github.com/traceypooh/blogtini
blog-theme esmodules github-pages highlightjs html javascript lunrjs markdown showdownjs static-site
Last synced: 3 months ago
JSON representation
Markdown + JS 100% client-side blogs & websites
- Host: GitHub
- URL: https://github.com/traceypooh/blogtini
- Owner: traceypooh
- Created: 2022-01-31T23:11:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T07:30:47.000Z (4 months ago)
- Last Synced: 2025-03-11T08:29:09.413Z (4 months ago)
- Topics: blog-theme, esmodules, github-pages, highlightjs, html, javascript, lunrjs, markdown, showdownjs, static-site
- Language: JavaScript
- Homepage: https://blogtini.com
- Size: 50 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# blogtini
## Slides / presentation
https://traceypooh.github.io/slides/dweb-2022
(tracey talk at https://dwebcamp.org)
Site live at:
- https://blogtini.com
- https://traceypooh.github.io/blogtini/
## Hooks
- Whenever you create or delete a post, we want your `sitemap` updated.
- Whenever someone comments on your site, we run a small script.
Thus, we suggest you use our "pre commit" and "post merge" `git` 'hooks' to automate the above "housekeeping". You can set them up like this:
```sh
git config --local core.hooksPath bin/
```
### RSS
If you'd like a RSS `index.xml` file generated with the [bin/sitemap](bin/sitemap) script,
during each "pre commit" hook (above), you'll need to have the
[yq](https://github.com/mikefarah/yq#install) script installed on your machine.
## Best two website/blog setup options
### Blog source repository that uses markdown inside html markup files
- /2022/01/i-baked-a-pie/
- /2022/01/i-baked-a-pie/index.html
- start with front matter
- including `comment: `
- you can then have the nice url `https://example.com/2022/01/i-baked-a-pie/` where the included JS transforms the markdown to markup
- your `/sitemap.xml` can reference each of your directory urls
- manage your `/sitemap.xml` manually or run the `/bin/sitemap` script any time you create or delete a post.
The [/bin/sitemap](https://github.com/traceypooh/blogtini/blob/main/bin/sitemap) script is on the blogtini website.
- have `/theme.js` do an `import` of whatever theme you desire
## Local development
### Option 1
`safari` is nice, you can run the site locally by just
- Developer Tools enabled
- `Develop` menu
- check `Disable Cross-Origin Restrictions` during development
- reload html page
- uncheck `Disable Cross-Origin Restrictions` when done
- example: file:///Users/tracey/dev/blogtini/index.html
### Option 2
(any basic static file webserver will do):
```bash
( sleep 3; open http://localhost:8000 ) &
python3 -m http.server
```
You can force a re-parse of posts & pages by adding optional CGI arg `?recache=1`
## Example urls using GitHub or GitLab pages
If you use https://github.com or https://gitlab.com free 'Pages' integration, you will get urls you can like this:
- https://traceypooh.github.io/blogtini/
- https://traceypooh.gitlab.io/blogtini/
You can choose to use your own domain name (typically ~$20 USD/year) for a shorter/nicer url that points to the Pages deployment above (this is what https://blogtini.com does)
## To Do / Fixmes
- `git grep xxxxx` highest priorities
- `git grep xxxx` medium priorities
- `git grep xxx` priorities
- staticman (reduced down) via netlify edge functions xxx
- document `?contact` xxx
- document github action xxx