Skip to content

Commit fee56f3

Browse files
committed
Update Component Library documentation
1 parent 370cb9d commit fee56f3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

general/development/tools/component-library.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ tags:
1212
- Usability
1313
---
1414

15-
# Component Library Overview
15+
## Component Library Overview
1616

1717
The **Component Library** is a tool designed for developers to identify frequently used user interface (UI) components and encourage their reuse within Moodle. It includes both components from **Twitter Bootstrap** and Moodle itself. The library provides an organized display of these components, showcasing them with your current Moodle theme.
1818

1919
This tool aims to assist developers working on Moodle themes, core features, and extensions by providing easy access to the UI components, which ultimately helps in creating more efficient and consistent user interfaces.
2020

21-
## Who Should Use the Component Library?
21+
### Who Should Use the Component Library?
2222

2323
The **Component Library** is useful for:
2424

@@ -27,17 +27,17 @@ The **Component Library** is useful for:
2727
- **UX developers**
2828
- Anyone working on **core Moodle code** or creating **Moodle extensions**.
2929

30-
## Getting Started
30+
### Getting Started
3131

32-
### Where is the Component Library?
32+
#### Where is the Component Library?
3333

3434
The library is built into Moodle but is only visible to developers. To access it, navigate to:
3535

3636
- **Site administration → Development → UI Component library**
3737

3838
If you can't see "**UI Component library**," you'll need to build it first (instructions below). You can also access the online version of the library at [Component Library Online](http://componentlibrary.moodle.com/admin/tool/componentlibrary/docspage.php/library/getting-started/).
3939

40-
### Building the Component Library
40+
#### Building the Component Library
4141

4242
Hugo tooling is used to create the Component Library, as is the Twitter Bootstrap framework. It includes the necessary Bootstrap libraries that correspond to the version used by Moodle.
4343

@@ -52,7 +52,7 @@ To build the Component Library, follow these steps:
5252

5353
This will build the **Component Library**.
5454

55-
## What Should Be Documented?
55+
### What Should Be Documented?
5656

5757
The main goal of the **Component Library** is to enhance UI consistency across Moodle. New UI components should be documented within the library whenever:
5858

0 commit comments

Comments
 (0)