Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
shenggaowei committed Nov 3, 2024
1 parent f751707 commit d4a2b5c
Showing 1 changed file with 2 additions and 58 deletions.
60 changes: 2 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,3 @@
# [tw93.fun](https://tw93.fun)
# blog

- This is Tw93's front-end technology blog.
- Commonly used to record learning and research front-end technology.
- Concerned about new technology and new thinking.
- The blog theme named [cosy-jekyll-theme](https://rubygems.org/gems/cosy-jekyll-theme) is created by [Tw93](https://tw93.fun/about/).

## Features

- cosy-jekyll-theme is a responsive blog template providing a good reading experience.
- **No jQuery**, no other redundant resources.
- Modern and minimal design, **more concise and faster** than other jekyll theme.
- **Responsive templates for post, page**, looks great on mobile, tablet, and desktop devices.
- **Loading resources selectively on different platforms.**
- **Support lazyload.**
- Compress JavaScript and CSS.
- By using SVG and Canvas makes this blog more geeks.
- When running in pc,It will show a qrCode that you can read on mobile.
- When the picture in articles is **too complicated to see it clearly,you can zoom it in full-screen.**
- Funny [custom 404 page](https://tw93.fun/err),You will like it.
- **More suitable for China**:

- Dropping google webfont, using proxy webfont.
- Delay loading of resources that are not immediately required.
- When Discus failed to load, It will be a good suggestion.
- Add buy me a coffee by using weChat payment.

## PC Preview

![demo.png](https://gw.alipayobjects.com/zos/k/nd/KOhiPv.jpg)

## H5 Preview

<img src="https://gw.alipayobjects.com/zos/k/yu/kkGDtF.jpg" width="270"/><img src="https://gw.alipayobjects.com/zos/k/2d/2.jpg" width="270"/><img src="https://gw.alipayobjects.com/zos/k/ki/3.jpg" width="270"/>

## QR code

<img src="https://gw.alipayobjects.com/zos/k/lu/3.png" width="200"/>

## How To Use

1. [Fork the repo](https://github.com/tw93/tw93.github.io)
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
3. Install bundler with `$ gem install bundler`
4. Install gems with `$ bundle install`
5. Run jekyll with `$ npm run dev`
6. Begin hacking for your project,You need modify `about.md` and `_config.yml`
7. For more details, read [documentation](http://jekyllrb.com/)

## Support

- **Feel free to fork. I'll appreciate it if you keep the author & github link at footer**.
- Give it **a star** if you like, fork or just clone to use.
- Having a problem getting something to work or want to know why I setup something in a certain way? [File a GitHub Issue](https://github.com/tw93/tw93.github.io/issues/new).
- If you make something cool with this theme feel free to let me know.

## License

- The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
Welcome to ShengGao's Blog

0 comments on commit d4a2b5c

Please sign in to comment.