summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 8 insertions, 43 deletions
diff --git a/README.md b/README.md
index 4bf9781..0c82882 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,15 @@
-![banner](https://raw.githubusercontent.com/tomfran/typo/main/images/banner-light.webp#gh-light-mode-only)
-![banner](https://raw.githubusercontent.com/tomfran/typo/main/images/banner-dark.webp#gh-dark-mode-only)
+# Tastefejl, a Hugo theme.
-<div align="center">
+Tastefejl is a fork of the [Typo] Hugo theme, with the following changes:
-[![wiki](https://img.shields.io/badge/doc-wiki-red?style=for-the-badge)](https://tomfran.github.io/typo-wiki/)
-[![GitHub Release](https://img.shields.io/github/v/release/tomfran/typo?style=for-the-badge)](https://github.com/tomfran/typo/releases/latest)
-[![last-commit](https://img.shields.io/github/last-commit/tomfran/typo?style=for-the-badge)](https://github.com/tomfran/typo/commits/)
-![stars](https://img.shields.io/github/stars/tomfran/typo?style=for-the-badge&color=orange)
+* Removed [Simple Icons] because I don't want to plaster brands on my website and at one point a 50MB .html file was committed
+ (I filtered the git history to reduce the size of the repository.)
-</div>
+[Typo]: https://github.com/tomfran/typo
+[Simple Icons]: https://simpleicons.org/
-# Typo, a Hugo theme.
+## Wiki
-Typo is a theme backed by simplicity, as you can see in the screenshots below. The goal was to have a website centered around content and nothing more.
-
-**Homepage**
-
-![1](https://raw.githubusercontent.com/tomfran/typo/main/images/1.webp)
-
-**Article**
-
-![2](https://raw.githubusercontent.com/tomfran/typo/main/images/2.webp)
-
-![3](https://raw.githubusercontent.com/tomfran/typo/main/images/3.webp)
-
-## 1 Wiki
-
-Typo's [Wiki](https://tomfran.github.io/typo-wiki/) is the place to find instructions on how to [setup](https://tomfran.github.io/typo-wiki/setup) the theme and an overview of the available [features](https://tomfran.github.io/typo-wiki/features).
+The [Wiki](./wiki/) is the place to find instructions on how to [setup](./wiki/setup.md) the theme and an overview of the available [features](./wiki/features).
Some of the most relevant are: heading auto-numbering, dark mode, color palettes, dark and light images, comments, etc.
-
-## 2 Support
-
-If you use the theme or found it useful you can support me by leaving a star ⭐ to Typo's Github repository.
-
-[Contributions](https://github.com/tomfran/typo/blob/main/CONTRIBUTING.md) are always welcome, feel free to open issues and PRs with fixes or new features.
-
-## 3 Typo Users
-
-If you're using Typo for your website, feel free to add your website to [the list](https://github.com/tomfran/typo/blob/main/USERS.md) alongside what you do! 😊
-
-## 4 Questions or ideas?
-
-Use the [discussion tab](https://github.com/tomfran/typo/discussions) to share ideas/tips/questions about Typo or Hugo in general!
-
-## 5 References
-
-The SVGs for social icons are taken from [Simple Icons](https://github.com/simple-icons/simple-icons).
-Every SVG present on the website is usable on the theme.