docs: update README.md
This commit is contained in:
parent
28dda5ad3b
commit
4268430bc4
20
README.md
20
README.md
|
@ -1,11 +1,12 @@
|
||||||
# jekyll-theme-yat
|
# jekyll-theme-yat
|
||||||
|
Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme is a modern theme, and it's quiet clear, clean and neat for writers and posts.
|
||||||
|
|
||||||
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`.
|
|
||||||
|
|
||||||
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
|
<p align="center">
|
||||||
|
|
||||||
TODO: Delete this and the text above, and describe your gem
|
<img src="https://user-images.githubusercontent.com/9413601/87244819-c34ada80-c472-11ea-9c67-5827dd55d3c7.png" alt="demo-screenshot" width="720px" style="box-shadow: 0px 0px 18px 5px #f2f2f2" />
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -33,10 +34,6 @@ Or install it yourself as:
|
||||||
|
|
||||||
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
|
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at https://github.com/jeffreytse/jekyll-theme-yat. 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
|
## Development
|
||||||
|
|
||||||
To set up your environment to develop this theme, run `bundle install`.
|
To set up your environment to develop this theme, run `bundle install`.
|
||||||
|
@ -46,7 +43,12 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
|
||||||
When your theme is released, only the files in `_data`, `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
|
When your theme is released, only the files in `_data`, `_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 `jekyll-theme-yat.gemspec` accordingly.
|
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-yat.gemspec` accordingly.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
|
||||||
|
|
||||||
|
You can start by [opening an issue](https://github.com/jeffreytse/jekyll-theme-yat/issues/new) describing the problem that you're looking to resolve and we'll go from there.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue