updated readme

This commit is contained in:
2022-05-31 19:27:38 +00:00
3 changed files with 68 additions and 23 deletions
+68 -22
View File
@@ -1,18 +1,17 @@
# html5up-readonly
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
This is a [Jekyll](https://jekyllrb.com/) theme based on the [Read Only](https://html5up.net/read-only) style, created by [HTML5 UP](https://html5up.net/).
To experiment with this code, add some sample content and run `bundle exec jekyll serve` this directory is setup just like a Jekyll site!
TODO: Delete this and the text above, and describe your gem
There is a [live demo of this theme](https://theme.digitaladapt.com/).
I have also created an experimental color, which I use on my website [DigitalAdapt.com](https://www.digitaladapt.com/); which can be used by appending `, branch: 'experimental'` to the gem line below.
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "html5up-readonly", "~> 0.1", github: 'digitaladapt/html5up-readonly'
gem "html5up-readonly", "~> 0.1", git: 'https://github.com/digitaladapt/html5up-readonly'
```
And add this line to your Jekyll site's `_config.yml`:
@@ -22,31 +21,78 @@ theme: html5up-readonly
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install html5up-readonly
```shell
bundle update
```
## Usage
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
Once installed into your Jekyll website, it should mostly just work, like any other theme, including the default.
To run your site locally call `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server complete with theme. Add pages, documents, data, etc. and see how things look. As you make modifications to your site content , your site will regenerate and you should see the changes in the browser after a refresh.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `html5up-readonly.gemspec` accordingly.
Bug reports and pull requests are welcome on GitHub at [https://github.com/digitaladapt/html5up-readonly](https://github.com/digitaladapt/html5up-readonly). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Customizing
Within your `_config.yml` file, you can specify a number of options to customize the theme.
```yaml
# Base Settings
title: Your awesome title
author: Some User
email: your-email@domain.com
description:
Write an awesome description for your new site here.
# Site URL
url: "https://theme.digitaladapt.com"
baseurl: /
# Matomo Tracking
# matomo_url: "://track.tld"
# matomo_siteId: 1
# Contact Me About This Page
page_contact: false
# Excerpts
show_excerpts: true
excerpt_separator: <!--more-->
# Avatar, image location override, default /images/avatar.jpg
# avatar: /images/avatar.jpg
# Banner, default location override, default /images/banner.jpg
# this can also be overridden on a per page basis.
# banner: /images/banner.jpg
# Social Links
rss: rss
twitter_username: digitaladapt
github_username: digitaladapt
bitbucket_username: digitaladapt
# "Copy ID" from user menu, may need to enable developer mode to see option
discord_id_number: "570971366833127425"
discord_username: "DigitalAdapt#8238"
keybase_username: digitaladapt
# instagram_username: digitaladapt
# dribbble_username: digitaladapt
# facebook_username: digitaladapt
# flickr_username: digitaladapt
# linkedin_username: digitaladapt
# pinterest_username: digitaladapt
# youtube_username: digitaladapt
# googleplus_username: +digitaladapt
# Mastodon Instances
# mastodon:
# - username: digitaladapt
# instance: example.com
```
-1
View File
@@ -11,7 +11,6 @@
<!-- Begin Icons, thanks to https://realfavicongenerator.net/ -->
<link rel="apple-touch-icon" sizes="180x180" href="{{ '/apple-touch-icon.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="32x32" href="{{ '/favicon-32x32.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="194x194" href="{{ '/favicon-194x194.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="192x192" href="{{ '/android-chrome-192x192.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="16x16" href="{{ '/favicon-16x16.png' | relative_url }}">
<link rel="manifest" href="{{ '/site.webmanifest' | relative_url }}">
Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB