Skip to content
thomasthaddeus edited this page Dec 8, 2023 · 1 revision

Welcome to the visionary-code-works Wiki

Welcome to the wiki for our Jekyll project! This comprehensive guide is designed to help you navigate through the various components of our Jekyll site. Whether you're a developer, content creator, or just curious about how things work, this wiki provides detailed documentation on the structure and management of the project.

Below is an overview of the key directories and files in our Jekyll project, each with its own dedicated page for more in-depth information.


Directory and File Documentation

Learn about the assets directory, where all static files like stylesheets, JavaScript, and images are stored. This section covers the organization, optimization, and best practices for managing your assets efficiently.

Understand the use of the _data directory, which stores YAML, JSON, or CSV files for dynamic content on the site. This documentation guides you on accessing and managing these data files.

Discover how the _drafts directory helps in managing unpublished blog posts. This section provides insights into drafting, previewing, and publishing content.

Explore the _includes directory, containing reusable HTML components like headers, footers, and navigation menus. Learn about modular design and reusing code efficiently.

Dive into the _layouts directory, which holds the template files for various page types. This section emphasizes consistency and best practices in layout design.

Get to know the pages directory, dedicated to individual Markdown files for static pages. This guide covers everything from front matter to content creation and best practices.

Find detailed information on the _posts directory, the heart of the blog or news section. Understand the structure, post creation, metadata consistency, and SEO optimization.

This section covers essential root files like CHANGELOG.md, Gemfile, LICENSE, README.md, and _config.yml, discussing their purpose and best practices.

Learn about the _sass directory, where SCSS files for the project are stored. This documentation helps in understanding modularity, consistency, and maintenance of styles.

Explore the scripts directory, which includes custom scripts for automation and task management. This guide covers best practices for script creation and usage.

Understand the role of the templates directory, housing templates for various site components and layouts. This section discusses consistency, responsive design, and template management.


Getting Started

If you're new to this project or Jekyll, start with the Getting Started Guide, which will walk you through the basics of setting up and running the project.

Contributing

Interested in contributing? Check out our Contribution Guidelines for information on how to contribute effectively to this project.