Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@
**Kot**lin B**log** is a CLI static blog generator - not intended for public or productional use. It features some handy shortcuts to streamline my content creation workflows.

## tl;dr
No, I do not think that you wanna use this Kotlin CLI. It is meant as a content creation helper for me needs. But if you find it interessering, awesome!
No, I do not think that you wanna use this Kotlin CLI. It is meant as a content creation helper for me needs. But if you find it interesting, awesome!

![](https://github.com/tscholze/kotlin-kotlog-cli/blob/main/docs/kotlog-desc.png?raw=true)

## Why?
I was looking for a simple static site blog generator. Jekyll and others were to over powered and too complex for my needs. Besides this, I wanted to have a more depth look into learning Koltin and going back to JetBrains IDEs.
I was looking for a simple static site blog generator. Jekyll and others were to over powered and too complex for my needs. Besides this, I wanted to have a more depth look into learning Kotlin and returning to JetBrains IDEs.

Besides this, I wanted to streamline my content creation workflows by letting do the programm do the heavy lifting in looking for information that are required for the resulting blog post.
Besides this, I wanted to streamline my content creation workflows by letting the program do the heavy lifting in looking for information that is required for the resulting blog post.

## Structure
- `__posts/` - contains all Markdown posts that will be rendered
- `__templates/` - contains all Markdown or html templates that will be used
- `__styles/` - contains all drop-in css style files
- `__output/` - is the regenerated html output directory
- `__templates/` - contains all Markdown or HTML templates that will be used
- `__styles/` - contains all drop-in CSS style files
- `__output/` - is the regenerated HTML output directory

## Usage

Clone the [kotlog-template repository](https://github.com/tscholze/kotlin-kotlog-template) first, than you are ready to run the CLI.
Clone the [kotlog-template repository](https://github.com/tscholze/kotlin-kotlog-template) first, then you are ready to run the CLI.

```
java -jar kotlog [...]
-c: 'My awesome title'`: Creates a new blog post
-y: beYqB6QXQuY`: Creates a YouTube post
-g: Generates html output
-g: Generates HTML output
-p: Publish aka pushes changes to remote
```
## How it looks
Expand All @@ -34,26 +34,26 @@ java -jar kotlog [...]
## Features
- Creating new blog post markdown files
- Supports Frontmatter for meta information
- Rendering markdown files into html blog articles
- Simple html styled by "drop-in" CSS themes
- Rendering markdown files into HTML blog articles
- Simple HTML styled by "drop-in" CSS themes
- Rendering a feed.json with snippets of blog articles
- Shortcut for creating blog posts by just providing e.g. a YouTube video id

## Ideas
- Switching to Kobweb / Compose for Web instead of html templates
- Switching to Kobweb / Compose for Web instead of HTML templates
- Embedding "auto share" of new blog posts
- Creating "social cards" that looks nice if you share the post on social media
- Creating "social cards" that look nice if you share the post on social media

## Warning
Do not use this tool in production or something else besides education. I just started studying Kotlin and I have no idea if the source that's generated or consumed by the CSS is GDPR or something else complient.
Do not use this tool in production or something else besides education. I just started studying Kotlin and have no idea if the source generated or consumed by the CSS is GDPR or something else compliant.

If you have any other warnings for me, please open an issue. I'm here to learn!

## Thanks to
The app is built on the work of giants. Without the following folks, repositories and posts, my tiny project would not exist.

- [David Herman (bitspittle)](https://github.com/bitspittle) - one of the most aspiring Kotlin educator and developer of Kobweb
- [Marcel Reiter (MarcelReiter)](https://github.com/MarcelReiter) - an awesome colleage and for never being tired of my beginners questions
- [Marcel Reiter (MarcelReiter)](https://github.com/MarcelReiter) - an awesome college and for never being tired of my beginners questions
- [Liam Doherty (dohliam)](https://github.com/dohliam/dropin-minimal-css#theme-collections) for curating the drop-in css collection which is used as `style` in the app

## License
Expand Down