-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,3 @@ | ||
# OneFlow Jekyll Theme | ||
# Sample website | ||
|
||
## What is it | ||
OneFlow is a Jekyll Theme designed to create stunning, clear and practical modern One-Pager Websites. | ||
It offers lots of features and customization options, so you can easily create a Site that matches your own or your client's wishes for design and structure. | ||
Check out the [Theme Website](https://oneflow-jekyll-theme.github.io/) showcasing and explaining the various opportunities the theme offers, and also check out the [first example website](https://oneflow-jekyll-theme-example-one.github.io/) and the [second example website](https://oneflow-jekyll-theme-example-two.github.io/) to see a few of the different design options the theme offers. | ||
|
||
## Full documentation | ||
Extensive documentation for OneFlow is available [here](https://perstarke-webdev.de/oneflow-jekyll-theme). | ||
|
||
## Getting started & development | ||
|
||
### Fork and clone this repository | ||
The **vision of this theme** is **simplicity and accessibility**, to easily create stunning websites from scratch. | ||
Therefore, it's not available as a classic gem-based Jekyll theme, but as a ready-to-use GitHub repository that you just need to fork and clone. | ||
So, get ahead and make a fork of this repository, rename it if you like to suit the name of the site you want to create, locally clone it, and directly start editing! | ||
|
||
Alternatively, you can just [download the theme as a zip file](https://oneflow-jekyll-theme.github.io/theme-download/oneflow-jekyll-theme.zip) to immediately get started. | ||
|
||
### How to start a development docker container | ||
To test your website and see all of your changes in real-time without deploying it online, you can easily build your site locally. | ||
- Make sure you have [Bundler](https://bundler.io/) and [Docker](https://www.docker.com/) installed. | ||
- Open up a terminal, navigate to your local repository, and run ```docker compose up```. | ||
|
||
Your site will then be visible at ```http://0.0.0.0:4000/``` in any browser. | ||
|
||
## News | ||
|
||
- OneFlow is now featured on [Jamstackthemes](https://jamstackthemes.dev/theme/oneflow/) | ||
- OneFlow is now featured on [jeyll-themes.com](https://jekyll-themes.com/perstarke-webdev/oneflow-jekyll-theme/) | ||
- OneFlow has been used to create the [arc42 Trainings dates page](https://trainings.arc42.org/) | ||
|
||
- Version 1.1 contains: | ||
- A default 404 page | ||
- A fix for responsiveness of the page hero on mobile screens in landscape mode | ||
based on the [Jekyll bulma-clean-theme](https://github.com/chrisrhymes/bulma-clean-theme) |