https://github.com/harrystaley/craftedtech-main
"craftedtech-main" is a repository designed for managing and previewing content using GitHub Pages and Jekyll. It provides resources and guidance for styling content with Markdown, allowing for easy customization and formatting of web pages.
https://github.com/harrystaley/craftedtech-main
github markdown
Last synced: 2 months ago
JSON representation
"craftedtech-main" is a repository designed for managing and previewing content using GitHub Pages and Jekyll. It provides resources and guidance for styling content with Markdown, allowing for easy customization and formatting of web pages.
- Host: GitHub
- URL: https://github.com/harrystaley/craftedtech-main
- Owner: harrystaley
- Created: 2019-01-02T02:10:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-12T08:47:08.000Z (about 1 year ago)
- Last Synced: 2025-04-12T09:38:52.050Z (about 1 year ago)
- Topics: github, markdown
- Language: Shell
- Size: 42 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# craftedtech-main
Welcome to the `craftedtech-main` repository, a comprehensive toolkit designed for managing and previewing content via GitHub Pages powered by Jekyll. This repository serves as a resource hub for anyone looking to style and customize their web pages using Markdown. Whether you're a beginner or an experienced developer, `craftedtech-main` provides the necessary tools and guidelines to enhance your web content effectively.
## Project Overview
The `craftedtech-main` repository is structured to facilitate easy management and customization of web content. Here's a brief overview of the project structure:
- **docs/**: Contains the Markdown files and resources for your GitHub Pages website.
- **_config.yml**: Jekyll configuration file to manage settings for your site.
- **assets/**: Houses CSS, JavaScript, and image files to style your content.
- **_layouts/**: Jekyll layouts that define the structure of your web pages.
- **index.md**: The main Markdown file that serves as the entry point of the GitHub Pages site.
## Setup and Installation
To get started with `craftedtech-main`, you need to have a basic understanding of GitHub, Markdown, and Jekyll. Follow these steps to set up the project:
### Prerequisites
- **Git**: Ensure you have Git installed on your machine. [Download Git here](https://git-scm.com/downloads).
- **Ruby**: Jekyll is a Ruby-based tool, so you will need Ruby installed. [Install Ruby](https://www.ruby-lang.org/en/downloads/).
- **Jekyll**: After installing Ruby, install Jekyll and bundler. Run:
```bash
gem install jekyll bundler
```
### Installation Steps
1. **Clone the repository**:
```bash
git clone https://github.com/yourusername/craftedtech-main.git
cd craftedtech-main
```
2. **Install dependencies**:
```bash
bundle install
```
3. **Build the site and make it available on a local server**:
```bash
bundle exec jekyll serve
```
4. **Browse to** `http://localhost:4000` to see your new website running locally.
## Usage Examples
After setting up the project, you can start customizing your content. Here are a few examples of how to use this repository:
- **Editing content**: To edit the content of your web pages, modify the Markdown files in the `docs/` directory.
- **Customizing styles**: Update the CSS files in the `assets/` directory to change the look and feel of your site.
- **Adding pages**: To add new pages, create new Markdown files in the `docs/` directory and define the layout in the YAML front matter.
## Contribution Guidelines
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have suggestions for how to improve `craftedtech-main`, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
---
Enjoy using `craftedtech-main` for your GitHub Pages and happy coding!