README
This commit is contained in:
parent
825bdcffe1
commit
f3252966fe
19
README.md
19
README.md
@ -1,23 +1,18 @@
|
|||||||
# Spectral - Jekyll Theme
|
|
||||||
|
|
||||||
A Jekyll version of the "Spectral" theme by [HTML5 UP](https://html5up.net/).
|
|
||||||
|
|
||||||
![Spectral Theme](screenshot.jpg "Spectral Theme")
|
|
||||||
|
|
||||||
# How to Use
|
# How to Use
|
||||||
|
|
||||||
For those unfamiliar with how Jekyll works, check out [https://jekyllrb.com/](https://jekyllrb.com/) for all the details,
|
For those unfamiliar with how Jekyll works, check out [https://jekyllrb.com/](https://jekyllrb.com/) for all the details,
|
||||||
or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/),
|
or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/),
|
||||||
and [creating pages](https://jekyllrb.com/docs/pages/).
|
and [creating pages](https://jekyllrb.com/docs/pages/).
|
||||||
|
|
||||||
- **GitLab**: Simply fork this repository and start editing the `_config.yml` file!
|
# Quickstart
|
||||||
- **GitHub**: Fork this reposity and create a branch named `gh-pages`, then start editing the `_config.yml` file! The `.gitlab-ci.yml` file is only needed for GitLab Pages, so feel free to delete this if you are using GitHub instead.
|
|
||||||
|
|
||||||
# Added Features
|
- Install Ruby if it's not already on your system
|
||||||
|
|
||||||
* Add your **social profiles** easily in `_config.yml`. Only social profiles buttons you enter in `config.yml` show up on the site footer!
|
```
|
||||||
* **Coming soon**: Set **featured images** in front matter.
|
gem install jekyll bundler
|
||||||
* **Coming soon**: Front page sections automatically pull from posts.
|
jekyll serve
|
||||||
|
```
|
||||||
|
- Edit `.md` files under `src` and `src/_posts`.
|
||||||
|
|
||||||
# Credits
|
# Credits
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user