Skip to content

Commit

Permalink
editing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonas Heinle committed Dec 16, 2024
1 parent 56926d5 commit 19fd977
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@
<a href="https://jonasheinle.de"><img src="images/glm_logo.png" alt="VulkanEngine" width="200"></a>
</h1> -->

<h4 align="center">My personal blog as responsive web app using Flutter/Dart. Every blog post is written in pure markdown and therefore very lightweight to use and add new content. It is highly customizable for your needs, your personal web blog or you next Frontend project (<b>not only</b> web but also native Linux/Windows/Android/Web/iOS)<a href="https://jonasheinle.de" target="_blank"></a>.</h4>
<h4 align="center">My personal blog as responsive web app using Flutter/Dart.
Every blog post is written in pure markdown :boom: and therefore very lightweight to use
and add new content.
It is highly customizable for your needs, your personal web blog or you next Frontend
project (<b>not only</b> web but also native Linux/Windows/Android/Web/iOS)
<a href="https://jonasheinle.de" target="_blank"></a>.</h4>

<p align="center">
<br>
Expand All @@ -24,11 +29,20 @@

> **__Note__**: If your run locally this website you are not able to
neither navigate to the blog entries nor the book/film/... critics.
Their "source content .md files" are my intellectual property and therefore only visible to me :) The flutter/dart source code stays
Their "source content .md files" are my intellectual property and therefore only visible to me :)
The flutter/dart source code stays
**__Open Source__** of course

Visit [jonasheinle.de](https://jonasheinle.de/) for the full experience of my personal web blog. Cheers! :beers: </br>
Visit my repo [jotrockenmitlockenrepo](https://github.com/Kataglyphis/jotrockenmitlockenrepo) if you are interested in Flutter/Dart development in general. All components in this repo are reusable for any target available (Linux/Windows/Android/Web).
Visit my repo [jotrockenmitlockenrepo](https://github.com/Kataglyphis/jotrockenmitlockenrepo) if you are interested
in Flutter/Dart development in general.
All components in this repo are reusable for any target available (Linux/Windows/Android/Web).

🚀 Markdown is great 🚀:
If you also love the lightweight markdown approach you might be interested in
my [md2pdf](https://github.com/Kataglyphis/Kataglyphis-mdToPdf)-project that even allows you to convert markdown to a a4paper PDF or presentation slides PDF :satisfied:
🎉🎉🎉


[![Build](https://github.com/Kataglyphis/jotrockenmitlocken/actions/workflows/dart.yml/badge.svg)](https://github.com/Kataglyphis/jotrockenmitlocken/actions/workflows/dart.yml)
[![TopLang](https://img.shields.io/github/languages/top/Kataglyphis/jotrockenmitlocken)]()
Expand Down Expand Up @@ -76,8 +90,11 @@ Visit my repo [jotrockenmitlockenrepo](https://github.com/Kataglyphis/jotrockenm
<!-- ABOUT THE PROJECT -->
## About The Project

I always wanted an easy way to publish new content (blog posts, thoughts about books,...) fast. But why not just using a CMS? Here are my reasons:
* as the content is pure markdown my approach allows me to always change the technology easily, many CMS integrate the content very strongly into their technology
I always wanted an easy way to publish new content :metal:
(blog posts, thoughts about books,...) fast.
But why not just using a CMS? Here are my reasons:
* as the content is pure markdown my approach allows me to always change the technology easily,
many CMS integrate the content very strongly into their technology
* therefore you will not make yourself dependent from my repo. You are always able to switch :cat2:
* what if I want to build an UI for a native Linux application? Than all effort brought
into building a web blog with a CMS is more or less useless. With this project I have
Expand All @@ -89,17 +106,20 @@ I always wanted an easy way to publish new content (blog posts, thoughts about b

### Content
I truly believe in open source. Hence you will get all source code for free use and ready to go.</br>
My approach allows me to separate the website data from its view (MVC best practice). You will not see my blog posts(only the dummy entries) in this repo. They are my intellectual property :wink:</br>
My approach allows me to separate the website data from its view (MVC best practice).
You will not see my blog posts(only the dummy entries) in this repo. They are my intellectual property :wink:</br>
The `assets` directory houses all files you want to include within your application namely:
* images
* videos
* data (.zip, .csv, ...)
* documents (f.e. .md for blog posts)
* fonts
* and the settings directory which harbors many different options for your own needs:
* global user settings: Here you can easily customize the blog for you. Set all necessary user related options (like email, name, image, etc...)
* global user settings: Here you can easily customize the blog for you.
Set all necessary user related options (like email, name, image, etc...)
* All entries in the user_skills.json will be displayed in the corresponding section.
* app settings: set the app name, title. You are able to disable the footer; the **supportedLocales** field can have the following values:
* app settings: set the app name, title. You are able to disable the footer;
the **supportedLocales** field can have the following values:
* ["de"]: build a web app in pure german
* ["en"]: build a web app in pure english
* ["de","en"] or :["en","de"] You can switch between english and german
Expand Down Expand Up @@ -210,7 +230,7 @@ apps](https://flutter.dev/docs/development/accessibility-and-localization/intern
### Built With

* [Flutter/Dart](https://flutter.dev/)
* [WebDavClient]() Wrote my own WebDavClient for this repo :)
* [WebDavClient](https://github.com/Kataglyphis/Kataglyphis-WebDavClient) Wrote my own WebDavClient for this repo :)

<!-- GETTING STARTED -->
## Getting Started
Expand Down Expand Up @@ -268,7 +288,7 @@ blockquote.

Jonas Heinle - [@Cataglyphis_](https://twitter.com/Cataglyphis_) - [email protected]

Project Link: [https://github.com/Kataglyphis/jonasheinle.de](https://github.com/Kataglyphis/jonasheinle.de)
Project Link: [https://github.com/Kataglyphis/jonasheinle.de](https://github.com/Kataglyphis/jotrockenmitlocken)


<!-- ACKNOWLEDGEMENTS -->
Expand Down

0 comments on commit 19fd977

Please sign in to comment.