Skip to content

Commit

Permalink
Doc - Add new navigation sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweener committed Oct 16, 2024
1 parent 41c2ae2 commit 408c576
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 13 deletions.
Empty file added docs/atoms/chip.md
Empty file.
Empty file added docs/atoms/icon.md
Empty file.
Empty file added docs/atoms/text.md
Empty file.
Empty file added docs/atoms/textfield.md
Empty file.
25 changes: 12 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,33 @@ use to build your app.

The **Atomic Design System** is a methodology for creating scalable, consistent, and reusable user interfaces by breaking down the UI into fundamental building blocks. It organizes components into five hierarchical levels:

1. [**Atoms**](#atoms)
The basic building blocks, such as buttons, icons, text inputs, and colors. These are the smallest indivisible elements of a UI.
1. [**Atoms**](#atoms): The basic building blocks, such as buttons, icons, text inputs, and colors. These are the smallest indivisible elements of a UI.

2. [**Molecules**](#molecules)
Simple combinations of atoms that work together, such as a search input with a button.
2. [**Molecules**](#molecules): Simple combinations of atoms that work together, such as a search input with a button.

3. [**Organisms**](#organisms)
More complex components composed of molecules and atoms, such as a header or a product card.
3. [**Organisms**](#organisms): More complex components composed of molecules and atoms, such as a header or a product card.

4. **Templates**
Layouts that arrange organisms in a specific structure, providing a blueprint for pages.
4. **Templates**: Layouts that arrange organisms in a specific structure, providing a blueprint for pages.

5. **Pages**
Fully-realized templates populated with real content, forming complete screens in an application.
5. **Pages**: Fully-realized templates populated with real content, forming complete screens in an application.

The atomic design system emphasizes **modularity** and **reusability**, making it easier to maintain, scale, and adapt the UI across different platforms while ensuring a consistent user experience.

!!! info "About Templates and Pages"

`Templates` and `Pages` levels are not managed by **CZAN**, as they represent screens, which are the responsibility of the library user to implement.

#### Atoms

Atoms are the basic building blocks of the user interface. They represent the simplest, indivisible components of a design. Atoms are often used on their own, but are also combined with others to create more complex elements.

Examples:

- Text
- [Button](atoms/button.md)
- Text field
- Chip
- Icon
- Chip, etc.
- Text
- TextField, etc.

#### Molecules

Expand Down
Empty file added docs/molecules/cardtip.md
Empty file.
Empty file.
Empty file added docs/molecules/tabs.md
Empty file.
Empty file added docs/organisms/card.md
Empty file.
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ theme:
name: Switch to light mode
features:
- content.code.copy
- navigation.expand

markdown_extensions:
- admonition
Expand All @@ -55,3 +56,13 @@ nav:
- "Setup": setup.md
- "Atoms":
- "Button": atoms/button.md
- "Chip": atoms/chip.md
- "Icon": atoms/icon.md
- "Text": atoms/text.md
- "TextField": atoms/textfield.md
- "Molecules":
- "CardTip": molecules/cardtip.md
- "NumericKeyboard": molecules/numerickeyboard.md
- "Tabs": molecules/tabs.md
- "Organisms":
- "Card": organisms/card.md

0 comments on commit 408c576

Please sign in to comment.