Skip to content

Commit 4d9ebeb

Browse files
committed
complete 60% of Folder Structure section
1 parent 71e52cb commit 4d9ebeb

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,36 @@ Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.
2222
It helps set up a consistent workspace for developers, ensuring everyone works with the same tools, settings and dependencies, regardless
2323
of their local set up.
2424

25+
```.github``` This folder is used to store GitHub-specifc configuration files for the repository. It helps manage automation, workflows, and guidelines
26+
for contribtors.
27+
28+
```_articles``` This folder contains all the written content (articles) for this project, organized by language and topic. These articles provide
29+
helpful guidance, best practices, and insights about contributing to open source projects.
30+
31+
```_data``` This folder contains data files (in formats like YAML) used to store structured information, like site settings, translations,
32+
or metadata. The repository reads these files to dynamically generate parts of the website, such as menus, translations or lists. The folder is important
33+
because it seperates content from code, making it easier to update data without changing the code itself
34+
35+
```_includes``` This folder contains reusable chunks of HTML code, like headers, footers, or components that appear on multiple pages.
36+
The files within this folder are inserted into larger templates or pages, reducing repetition and keeping the code organized. This folder
37+
ensures consistency across the site and makes it easy to update shared elements in one place instead of multiple files.
38+
39+
```_layouts``` This folder contains layouts templates (files) for the site, each file in the folder is a template for a page on the application.
40+
The layout templates in this folder act like blueprints, they determing where certain parts of the page goes and storing all the templates in this folder allows
41+
for components to be reused across multiple pages this helps to keep the site consistent and easier to maintain.
42+
43+
```assets``` This folder contains static files like images, CSS (styles), and JavaScript (scripts) used to style and add functionality to the website.
44+
These files are served to users when they visit the site, making it look nice and interactive. Storing all the designs and functionality-related files in one place,
45+
keeps the repository organized.
46+
47+
```docs``` This folder holds documentation files related to the project. It provides extra information for developers or contributors,
48+
like how to set up or use the project. This extra information gives developers the opportunity to contribute to this repository beyond just the README file.
49+
50+
```node_modules``` This folder contains all the dependencies (external libraries and tools) managed by Node.js, which are needed to build or run the project.
51+
It provides the code libraries the project relies on, such as tools for building the website and running workflows.
52+
53+
54+
2555

2656
## Acknowledgments
2757

0 commit comments

Comments
 (0)