Hello world

Thank you for purchasing my theme. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!

Wind

Created: 01/10/23
By: Andres Chacon

You are in front of a Jekyll site. Inside this jekyll site is mounted my theme (specific in the wind folder).

Structure
Running
Usage
Customization
Deploying

Structure

├── about.markdown
├── _config.yml
├── Gemfile
├── Gemfile.lock
├── index.markdown -> your home/index/main page
├── _posts -> your posts here
│   ├── 2023-10-16-example-post.markdown
│   ├── 2023-10-16-headphones.markdown
│   ├── 2023-10-16-welcome-to-jekyll.markdown
│   └── 2023-10-16-welcome-to-wind.markdown
├── README.md
├── tags.md
└── wind -> theme folder
    ├── 404.html
    ├── assets
    ├── Gemfile
    ├── Gemfile.lock
    ├── _includes
    ├── _layouts
    ├── package.json
    ├── package-lock.json
    ├── README.md
    ├── tailwind.config.js
    └── wind.gemspec

Running

To run this project on your machine, you need to have Ruby installed. We recommend installing the latest stable version. You can do this by following the instructions detailed on the Ruby installation page(https://www.ruby-lang.org/en/documentation/installation/).

Viewing Your Project Locally

Open a Terminal/Command Prompt:
- Open a terminal or command prompt on your computer.
Navigate to Your Project Directory:
- Use the cd command to change the current working directory to your Jekyll project’s root folder. For example:
```
cd path/to/your/jekyll/project
```
Install Dependencies:
- If you haven’t done so already, run the following command to install Jekyll and other necessary dependencies for your project:
```
bundle install
```
Serve Your Jekyll Site:
- To start a local development server and view your Jekyll site, run:
```
bundle exec jekyll serve
```
Access Your Local Site:
- Open your web browser and navigate to http://localhost:4000 to view your Jekyll site locally.
Edit and Customize:
- Make changes to your site’s content, layout, and configurations. Your site will automatically regenerate as you make changes, thanks to the local server.
Stop the Local Server:
- To stop the local server, press Ctrl + C in the terminal or command prompt where the server is running.

Running your Jekyll site locally allows you to preview changes and test your site before deploying it to a live web server.

Enjoy developing and customizing your Jekyll site!

Theme Usage

Using this theme is straightforward, similar to other Jekyll themes. You can refer to the included theme documentation here, or you can consult the README.md file inside the theme folder for detailed instructions. If you’re new to Jekyll theming or need more guidance, we recommend reviewing the Jekyll documentation on themes.

Customization

If you want to dive deeper into customization, you can tailor this theme by generating new layouts, creating custom includes, or modifying existing ones. It’s worth noting that this theme was developed using Tailwind CSS and pure JavaScript, providing flexibility for customization.

To begin the customization process, follow these steps:

Navigate to the Theme Folder:
- First, navigate to the theme folder within your project.
Install npm Packages:
- Make sure you have npm (Node Package Manager) installed on your system. If not, you can install it from here.
Install Required Packages:
- Inside the theme folder, locate the package.json file and install the necessary packages defined in it by running the following command:
```
npm install
```
Install npx:
- If you haven’t installed npx (Node Package Runner) yet, you can do so by running:
```
npm install -g npx
```
Start the Build Process:
- To initiate the build process, run the following command in your theme folder:
```
npx tailwindcss -i ./assets/css/style.css -o ./assets/dist-style.css --watch
```
This command compiles the Tailwind CSS and outputs the result to wind/assets/dist-style.css.

For more detailed information on Tailwind CSS installation and usage, you can refer to the official Tailwind CSS documentation(https://tailwindcss.com/docs/installation).

Feel free to explore and modify the theme’s styles, layout, and functionality according to your specific requirements.

Deploying

This documentation provides quick steps to deploy this theme on GitHub Pages and GitLab Pages.

GitHub Pages

Create a GitHub Repository:
- Create a repository with the format username.github.io.
- Push your Jekyll theme’s code to this repository.
Configure Repository Settings:
- Go to repository settings.
- Scroll down to GitHub Pages.
- Set the source to GitHub Actions
Access Your Site:
- Your Jekyll theme will be available at https://username.github.io.

GitLab Pages

Create a GitLab Repository:
- Create a repository for your Jekyll theme.
Push Your Code:
- Push your theme’s code to the GitLab repository.
GitLab Pages Settings:
- This theme already have a .gitlab-ci.yml file.
Access Your Site:
- After a successful pipeline run, your Jekyll theme will be available at a URL provided by GitLab Pages.

That’s it! This site can be easily deployed on both GitHub Pages and GitLab Pages.

Once again, thank you so much for purchasing this theme. As I said at the beginning, I’d be glad to help you if you have any questions relating to this theme. No guarantees, but I’ll do my best to assist. If you have a more general question relating to the themes on ThemeForest, you might consider visiting the forums and asking your question in the “Item Discussion” section.

Documentation