diff options
author | Christoph Cullmann <cullmann@kde.org> | 2021-08-29 11:48:16 +0200 |
---|---|---|
committer | Christoph Cullmann <cullmann@kde.org> | 2021-08-29 11:48:16 +0200 |
commit | 0321812a29e6ec32663556fa7abe2bf2880e5762 (patch) | |
tree | abe0294bd63c046d2b5a164d987d67a64db2c2f6 /themes/CodeIT/README.md | |
parent | f2375511935010a1aeee5683c30b3efb928bef2e (diff) |
update to https://github.com/sunt-programator/CodeIT/releases/tag/v0.2.0
Diffstat (limited to 'themes/CodeIT/README.md')
-rw-r--r-- | themes/CodeIT/README.md | 49 |
1 files changed, 33 insertions, 16 deletions
diff --git a/themes/CodeIT/README.md b/themes/CodeIT/README.md index de4d7ae..8a5b22d 100644 --- a/themes/CodeIT/README.md +++ b/themes/CodeIT/README.md @@ -16,7 +16,7 @@ read [Why to choose CodeIT](#why-choose-CodeIT) so that you can choose the one t ![Hugo Theme CodeIT](https://github.com/sunt-programator/CodeIT/raw/master/images/Apple-Devices-Preview.png) -## Brief history +## :hourglass_flowing_sand: Brief history This theme is based on the original [LoveIt](https://github.com/dillonzq/LoveIt) theme. The original theme was loved by many users, but since May 2020 it has not been maintained. @@ -24,11 +24,11 @@ We tried to contact the theme [owner](https://github.com/dillonzq), but without So we decided to create and maintain the theme with a new name, keeping the original style, but continuously improving it. Feel free to contribute to this theme π. -## [Demo Site](https://codeit.suntprogramator.dev/) +## :computer: Demo Site To see this theme in action, here is a live [demo site](https://codeit.suntprogramator.dev/) that is rendered with the **CodeIT** theme. -## Why choose CodeIT +## :question: Why choose CodeIT Compared to the original LeaveIt theme and the KeepIt theme, the CodeIT theme has the following modifications. @@ -64,9 +64,9 @@ the CodeIT theme may be more suitable for you. I hope you will CodeIT π©βπ»! -## Features +## :open_book: Features -### Performance and SEO +### :zap: Performance and SEO - Optimized for **performance**: 99/100 on mobile and 100/100 on the desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights) - Optimized SEO performance with a correct **SEO SCHEMA** based on JSON-LD @@ -77,7 +77,7 @@ I hope you will CodeIT π©βπ»! - **CDN** for third-party libraries supported - Automatically converted images with **Lazy Load** by [lazysizes](https://github.com/aFarkas/lazysizes) -### Appearance and Layout +### :desktop_computer: Appearance and Layout - **Responsive** layout - **Light/Dark** mode @@ -87,7 +87,7 @@ I hope you will CodeIT π©βπ»! - **Multilanguage** supported and i18n ready - Beautiful **CSS animation** -### Social and Comment Systems +### :thought_balloon: Social and Comment Systems - **Gravatar** supported by [Gravatar](https://gravatar.com) - Local **Avatar** supported @@ -100,8 +100,10 @@ I hope you will CodeIT π©βπ»! - **Telegram comments** system supported by [Telegram Comments](https://comments.app/) - **Commento** comment system supported by [Commento](https://commento.io/) - **Utterances** comment system supported by [Utterances](https://utteranc.es/) +- **Waline** comment system supported by [Waline](https://waline.js.org/) +- **Twikoo** comment system supported by [Twikoo](https://twikoo.js.org/) -### Extended Features +### :sparkles: Extended Features - **Search** supported by [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/) - **Twemoji** supported @@ -125,7 +127,7 @@ I hope you will CodeIT π©βπ»! - **Cookie consent banner** supported by [cookieconsent](https://github.com/osano/cookieconsent) - ... -## Add the theme to your blog +## :dart: Add the theme to your blog First, download the theme from GitHub and add it to your siteβs themes directory: @@ -147,7 +149,7 @@ Then, add the theme to the site configuration: echo 'theme = "CodeIT"' >> config.toml ``` -## [Build documentation instructions](https://codeit.suntprogramator.dev/categories/documentation/) +## :page_facing_up: [Build documentation instructions](https://codeit.suntprogramator.dev/categories/documentation/) You can build the theme documentation locally by using a [devcontainer](https://code.visualstudio.com/docs/remote/containers) or by manually install the [`Hugo`](https://gohugo.io/getting-started/installing). The main advantage of the `devcontainer` is that you will have a preconfigured container with all tools required for developing and building the theme documentation. @@ -156,7 +158,7 @@ The main advantage of the `devcontainer` is that you will have a preconfigured c hugo server --source=exampleSite ``` -## Multilingual and i18n +## :earth_africa: Multilingual and i18n CodeIT supports the following languages: @@ -176,11 +178,11 @@ CodeIT supports the following languages: [Languages Compatibility](https://codeit.suntprogramator.dev/theme-documentation-basics/#language-compatibility) -## Questions, ideas, bugs, pull requests +## :question: Questions, ideas, bugs, pull requests All feedback is welcome! Head over to the [issue tracker](https://github.com/sunt-programator/CodeIT/issues). -## License +## :scroll: License CodeIT is licensed under the **MIT** license. Check the [LICENSE file](https://github.com/sunt-programator/CodeIT/blob/master/LICENSE) for details. @@ -211,13 +213,13 @@ Thanks to the authors of the following resources included in the theme: - [Valine](https://valine.js.org/) - [cookieconsent](https://github.com/osano/cookieconsent) -## Sponsor +## :moneybag: Sponsor If you enjoy the theme, please consider buying me a coffee βοΈ. - [PayPal](https://paypal.me/victorpogor) -## Contributors β¨ +## :tada: Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -229,7 +231,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d <td align="center"><a href="https://suntprogramator.dev/"><img src="https://avatars1.githubusercontent.com/u/24962085?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Victor Pogor</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=victor-pogor" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Avictor-pogor" title="Bug reports">π</a> <a href="#projectManagement-victor-pogor" title="Project Management">π</a></td> <td align="center"><a href="https://github.com/dillonzq"><img src="https://avatars1.githubusercontent.com/u/30786232?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dillon</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=dillonzq" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Adillonzq" title="Bug reports">π</a> <a href="#projectManagement-dillonzq" title="Project Management">π</a></td> <td align="center"><a href="https://giuseppepignataro.eu/"><img src="https://avatars0.githubusercontent.com/u/16869546?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Giuseppe Pignataro</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=Fastbyte01" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3AFastbyte01" title="Bug reports">π</a> <a href="#projectManagement-Fastbyte01" title="Project Management">π</a></td> - <td align="center"><a href="http://www.thatamazingprogrammer.com/"><img src="https://avatars0.githubusercontent.com/u/11393826?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Christopher C. Johnson</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=Programazing" title="Code">π»</a></td> + <td align="center"><a href="http://www.thatamazingprogrammer.com/"><img src="https://avatars0.githubusercontent.com/u/11393826?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Christopher C. Johnson</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=Programazing" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3AProgramazing" title="Bug reports">π</a> <a href="https://github.com/sunt-programator/CodeIT/commits?author=Programazing" title="Documentation">π</a></td> <td align="center"><a href="https://astropengu.in/"><img src="https://avatars2.githubusercontent.com/u/13254278?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Akio Taniguchi</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=astropenguin" title="Code">π»</a></td> <td align="center"><a href="https://www.holo.co.de/"><img src="https://avatars0.githubusercontent.com/u/6415842?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dave A-W</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=DaveA-W" title="Code">π»</a></td> <td align="center"><a href="https://blog.realsangil.net/"><img src="https://avatars1.githubusercontent.com/u/15508203?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sangil Park</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=realsangil" title="Code">π»</a></td> @@ -267,6 +269,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d <td align="center"><a href="https://github.com/SilkeHenderickx"><img src="https://avatars0.githubusercontent.com/u/28140438?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Silke Henderickx</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=SilkeHenderickx" title="Code">π»</a></td> <td align="center"><a href="https://ghos.in/"><img src="https://avatars1.githubusercontent.com/u/26043355?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ghosin</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=Ghosin" title="Code">π»</a></td> <td align="center"><a href="https://automationd.com/"><img src="https://avatars2.githubusercontent.com/u/1790594?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dmitry Kireev</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=AutomationD" title="Code">π»</a></td> + <td align="center"><a href="https://michaeloliver.dev"><img src="https://avatars3.githubusercontent.com/u/55017335?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michael Oliver</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=michael0liver" title="Code">π»</a></td> + <td align="center"><a href="https://epogrebnyak.github.io"><img src="https://avatars3.githubusercontent.com/u/9265326?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Evgeny Pogrebnyak</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Aepogrebnyak" title="Bug reports">π</a> <a href="#ideas-epogrebnyak" title="Ideas, Planning, & Feedback">π€</a></td> + </tr> + <tr> + <td align="center"><a href="https://sosiristseng.github.io"><img src="https://avatars2.githubusercontent.com/u/40054455?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wen Wei Tseng</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=sosiristseng" title="Code">π»</a></td> + <td align="center"><a href="https://www.sheldonhull.com"><img src="https://avatars.githubusercontent.com/u/3526320?v=4?s=100" width="100px;" alt=""/><br /><sub><b>sheldonhull</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=sheldonhull" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Asheldonhull" title="Bug reports">π</a></td> + <td align="center"><a href="https://github.com/jadmadi"><img src="https://avatars.githubusercontent.com/u/29486218?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Madi</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=jadmadi" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Ajadmadi" title="Bug reports">π</a></td> + <td align="center"><a href="https://tmendes.gitlab.io/28lbackpack"><img src="https://avatars.githubusercontent.com/u/16507629?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Thiago Mendes</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=trmendes" title="Code">π»</a></td> + <td align="center"><a href="http://aimoon.top"><img src="https://avatars.githubusercontent.com/u/61509470?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yasin</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Aaiyasin" title="Bug reports">π</a></td> + <td align="center"><a href="http://www.jesustorres.es/"><img src="https://avatars.githubusercontent.com/u/266452?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JesΓΊs Torres</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=aplatanado" title="Code">π»</a></td> + <td align="center"><a href="https://github.com/ktw717"><img src="https://avatars.githubusercontent.com/u/19327709?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Karl Webster</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=ktw717" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/commits?author=ktw717" title="Documentation">π</a></td> + </tr> + <tr> + <td align="center"><a href="https://github.com/OnlyFor"><img src="https://avatars.githubusercontent.com/u/16849187?v=4?s=100" width="100px;" alt=""/><br /><sub><b>OnlyFor</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=OnlyFor" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/commits?author=OnlyFor" title="Documentation">π</a></td> + <td align="center"><a href="https://tbm98.dev"><img src="https://avatars.githubusercontent.com/u/52562340?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Minh Tran</b></sub></a><br /><a href="https://github.com/sunt-programator/CodeIT/commits?author=tbm98" title="Code">π»</a> <a href="https://github.com/sunt-programator/CodeIT/issues?q=author%3Atbm98" title="Bug reports">π</a></td> </tr> </table> |