Browse Source

Reorganize README

master
angristan 5 months ago
parent
commit
1dbed3a187
1 changed files with 19 additions and 16 deletions
  1. +19
    -16
      README.md

+ 19
- 16
README.md View File

@@ -6,31 +6,34 @@ For more information regarding how to use the theme with Ghost, please refer to

## Fork

I keep my fork up-to-date with the upstream.
I keep my fork [up-to-date](https://github.com/angristan/Casper-XYZ/wiki/Maintaining-the-fork) with the upstream.

List of the modifications made in this fork:

* [Custom CSS (lots of stuff, commented)](https://github.com/Angristan/Casper-XYZ/blob/master/assets/css/custom.css)
* [Removed share buttons in the header](https://github.com/Angristan/Casper-XYZ/commit/b4530b973a71bcdfce82c02572525171a5fa9159)
* [Replaced Feedly links by original RSS links](https://github.com/Angristan/Casper-XYZ/commit/c618bc702969c217b6f48277244b6bf04b4e46bd)
* [Added Isso for comments](https://github.com/Angristan/Casper-XYZ/blob/master/post.hbs#L71)
* [Host jQuery locally](https://github.com/Angristan/Casper-XYZ/commit/50b425d7c1a370bd44d599d597b25623f8c8936b)
* [Use the Open Sans Pro font](https://github.com/Angristan/Casper-XYZ/blob/master/assets/css/custom.css#L1)
* [Header image is the same width as the content, and the content doesn't step on it](https://github.com/Angristan/Casper-XYZ/commit/1c0fd7d699651d7413028d130f59e20dbcab498e)
* [GitHub, Mastodon, Linkedin, Instagram and Shaarli links and SVG icons](https://github.com/Angristan/Casper-XYZ/blob/master/partials/site-nav.hbs#L16)
* Added GitHub action for CI instead of Travis
* [Use GitLab-like font for code blocks instead of ugly monospace](https://github.com/angristan/Casper-XYZ/blob/master/assets/css/custom.css#L163)
* [Custom CSS](https://github.com/angristan/Casper-XYZ/blob/master/assets/css/custom.css)
* Use the Open Sans Pro font
* Header image is the same width as the content, and the content doesn't step on it
* Use GitLab-like font for code blocks instead of ugly monospace
* Disable dark mode
* A lot more, check the comments!
* [Removed share buttons in the header](https://github.com/angristan/Casper-XYZ/commit/b4530b973a71bcdfce82c02572525171a5fa9159)
* [Replaced Feedly links by original RSS links](https://github.com/angristan/Casper-XYZ/commit/c618bc702969c217b6f48277244b6bf04b4e46bd)
* [Host jQuery locally](https://github.com/angristan/Casper-XYZ/commit/50b425d7c1a370bd44d599d597b25623f8c8936b)
* [GitHub, Mastodon, Linkedin, Instagram and Shaarli links and SVG icons](https://github.com/angristan/Casper-XYZ/blob/master/partials/site-nav.hbs#L16)
* [Use GitHub Actions for CI instead of Travis (test + deploy)](https://github.com/angristan/Casper-XYZ/tree/master/.github/workflows)
* [Replaced estimated reading time on posts list by the release date](https://github.com/angristan/Casper-XYZ/pull/4)
* [Backported AMP template to theme for customisation (Google Analytics and Matomo)](https://github.com/angristan/Casper-XYZ/blob/master/amp.hbs)
* Disable dark mode
* [Backported AMP template to theme for customization](https://github.com/angristan/Casper-XYZ/blob/master/amp.hbs)

### Hardcoded stuff

I try to make the theme reusable as possible, but I still have to hardcode some stuff.

* [Isso comments block](https://github.com/Angristan/Casper-XYZ/blob/master/post.hbs#L71)
* [GitHub, Mastodon, Linkedin, Instagram and Shaarli links](https://github.com/Angristan/Casper-XYZ/blob/master/partials/site-nav.hbs#L16)
* [Vultr affiliate link](https://github.com/angristan/Casper-XYZ/blob/master/default.hbs#L32)
* [Disqus comments](https://github.com/angristan/Casper-XYZ/blob/master/post.hbs)
* [GitHub, Mastodon, Linkedin, Instagram and Shaarli links](https://github.com/angristan/Casper-XYZ/blob/master/partials/site-nav.hbs)
* [Vultr affiliate link](https://github.com/angristan/Casper-XYZ/blob/master/default.hbs)
* [Google Analytics and Matomo in AMP](https://github.com/angristan/Casper-XYZ/blob/master/amp.hbs)

**MAKE SURE TO UPDATE/REMOVE THEM IF YOU PLAN ON REUSING MY THEME!**

### External assets embedded



Loading…
Cancel
Save