Skip to content

Commit 484f2c9

Browse files
ericfenniskarsa-mistmereCopilot
authored
docs(version-1): Version 1 website (#4142)
* Update images * Adjust color * update accessebility * Add matrix hero * Add typescript documentation * Add basics section to vue pages * Add svelte docs * Fix dynamic sidebar * Add animation? * Some adjustments * Adjust animation * Updates docs * Add scaledown animation * Add docs for vue types * Fix layout accessibility page * fix framework select * adjust easing home animation * Write docs for Vue * Adjust animation home * Adjust home hero animation * Finish svelte docs * Add solid pages * remove spiral animation component * Add group icons * Added solid docs * update preact docs * Adjust examples preact docs * Add snackplayer * Get new editor * Save this * Add examples * Adjust styling * setup custom sandpack * Add script * Format files * Make sandpack plugin work * migrate react docs * Fix svelte and solid examples * Migrate to solid packages * Add darkmode package logos * Fix bug in selector * migrate vue examples * migrate advanced vue items * migrate preact and svelte examples * Add astro docs * adding more docs on guide for lucide library * Fix home animation * Cleanup * Added resources page, with more details and content * Add hero badge for Version 1 * Fix vercel json * Update missing paths * Fix build? * Replace lucide-vue-next * Fix build * Add some docs * update markdown * Setup angular docs * Add basic angular docs * Adjust code examples * Update title and descriptions * Update accessibility link * Update title and description * Add og image * Fix alignment * Add migration guides * Adjust version 1 markdown file * Add migration guide to the main list * Minor fixes * Update docs * Apply feedback * Select icons * Add pointer events none * Fix package links homepage * Format code * Fix types * Fix focus * Fix build * Fix focus * Apply feedback * Adjust imports * Adjust imports * Fix search * Apply feedback * Fix import in font docs * Small fixes * docs(guide): added easter egg icon. stay tuned, guys 😉 * Add llm txt plugin * Adjust logo top * docs(version-1): upgraded @lucide/angular guide for v1 website (#4144) * docs(guide/angular): rewrite some angular documentation * docs(guide/angular): extens angular guide with combining icons & icon provider guides * docs(guide/angular): fix angular sandbox, still needs @lucide/angular release tho * docs(guide/angular): rework the getting started page a bit more, refactor some more prop=>input occurences * docs(guide/angular): context provider => provideLucideConfig * Update docs/guide/angular/migration.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Update docs/guide/angular/advanced/combining-icons.md Co-authored-by: Eric Fennis <eric.fennis@gmail.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(guide/angular): rework a11y for better flow & pacing * docs(guide/angular): salvage original phrase, it has better flow * docs(guide/angular): some more a11y nitpicking * docs(guide/angular): reduce llm fatigue * docs(guides/angular): fix app component selector * docs(guides/angular): fix angular sandpacks * Add sandpack angular to improve tree-shakable stack * Update docs/guide/angular/getting-started.md * docs(guides/angular): fix user import in combinding icons guide * docs(guides/angular): fix nested SVG phrasing * Update docs/guide/angular/advanced/with-lucide-lab.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/angular/advanced/filled-icons.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs(guides/angular): fix createLucideIcon guide * docs(guides/angular): upgrade all relevant angular sandpack demos --------- Co-authored-by: Eric Fennis <eric.fennis@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(docs): add autogenerated OG images to gitignore * fix(docs): unify the case of "Lucide" & "Lucide Lab" over all docs and readmes * Fix build * Add next tag to all installation guides * Add top bar notification * Minor fixes * Update text * Add todos * Update og image * Adjust install command * Color top bar * fix(docs): ignore all OG images, expect general.png * fix(docs): fix the package list, hide @lucide/icons, downgrade angular logo, link to v0 guide, fix package title alignment * Update docs/.vitepress/theme/components/base/LayoutTop.vue Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/guide/react/advanced/dynamic-icon-component.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/.vitepress/sidebar/resources.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix code example * fix(docs): version 1 => Version 1 * feat(docs): add angular to new features in v1 * Fix next line issue * feat(docs): fix typo (code example_s_) * Fix deadlink * feat(docs): fix some more typos and irky grammar * feat(docs): fix lowercase lucide in sidebar 😅 * Update docs/guide/version-1.md Co-authored-by: Karsa <contact@karsa.org> --------- Co-authored-by: Karsa <contact@karsa.org> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent e715245 commit 484f2c9

314 files changed

Lines changed: 15453 additions & 2310 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/labeler.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,51 +36,51 @@
3636
- any-glob-to-any-file:
3737
- 'packages/lucide/*'
3838

39-
# For changes in the lucide React package
39+
# For changes in the Lucide React package
4040
⚛️ react package:
4141
- changed-files:
4242
- any-glob-to-any-file:
4343
- 'packages/lucide-react/*'
4444

45-
# For changes in the lucide React Native package
45+
# For changes in the Lucide React Native package
4646
⚛️ react native package:
4747
- changed-files:
4848
- any-glob-to-any-file:
4949
- 'packages/lucide-react-native/*'
5050

51-
# For changes in the lucide vue packages
51+
# For changes in the Lucide vue packages
5252
💎 vue package:
5353
- changed-files:
5454
- any-glob-to-any-file:
5555
- 'packages/lucide-vue/*'
5656
- 'packages/lucide-vue-next/*'
5757

58-
# For changes in the lucide angular package
58+
# For changes in the Lucide angular package
5959
🅰️ angular package:
6060
- changed-files:
6161
- any-glob-to-any-file:
6262
- 'packages/angular/*'
6363
- 'packages/lucide-angular/*'
6464

65-
# For changes in the lucide preact package
65+
# For changes in the Lucide preact package
6666
⚛️ preact package:
6767
- changed-files:
6868
- any-glob-to-any-file:
6969
- 'packages/lucide-preact/*'
7070

71-
# For changes in the lucide svelte package
71+
# For changes in the Lucide svelte package
7272
🧣 svelte package:
7373
- changed-files:
7474
- any-glob-to-any-file:
7575
- 'packages/lucide-svelte/*'
7676

77-
# For changes in the lucide solid package
77+
# For changes in the Lucide solid package
7878
🪝 solid package:
7979
- changed-files:
8080
- any-glob-to-any-file:
8181
- 'packages/lucide-solid/*'
8282

83-
# For changes in the lucide astro package
83+
# For changes in the Lucide astro package
8484
🚀 astro package:
8585
- changed-files:
8686
- any-glob-to-any-file:
@@ -92,13 +92,13 @@
9292
- any-glob-to-any-file:
9393
- 'packages/lucide-icons/*'
9494

95-
# For changes in the lucide static package
95+
# For changes in the Lucide static package
9696
🪨 static package:
9797
- changed-files:
9898
- any-glob-to-any-file:
9999
- 'packages/lucide-static/*'
100100

101-
# For changes in the lucide flutter package
101+
# For changes in the Lucide flutter package
102102
🏹 flutter package:
103103
- changed-files:
104104
- any-glob-to-any-file:

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,6 @@ docs/.vitepress/data/relatedIcons.json
5050
docs/.vitepress/data/brandStopwords.json
5151
docs/.vercel
5252
docs/.nitro
53+
docs/public/og/**
54+
!docs/public/og/general.png
5355
.gitignore

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"cSpell.words": ["devs", "preact", "Preact"],
33
"eslint.enable": true,
44
"eslint.validate": ["javascript", "svg"],
5-
"svg.preview.background": "transparent"
5+
"svg.preview.background": "editor"
66
}

BRAND_LOGOS_STATEMENT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Our Official Stance on Including Brand Logos in Lucide
1+
# Brand Logos Statement
2+
3+
Our official stance on including brand logos in Lucide
24

35
## TL;DR
46

CODE_OF_CONDUCT.md

Lines changed: 69 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,90 @@
11
# Contributor Covenant Code of Conduct
22

3+
This Code of Conduct outlines our expectations for participant behavior as well as the consequences for unacceptable behavior within our community. We are committed to providing a welcoming, safe, and inclusive environment for all members of our community.
4+
35
## Our Pledge
46

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
7+
We pledge to make our community welcoming, safe, and equitable for all.
118

12-
## Our Standards
9+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
1310

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
11+
## Encouraged Behaviors
1612

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
13+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
2214

23-
Examples of unacceptable behavior by participants include:
15+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
2416

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
17+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
18+
2. Engaging **kindly and honestly** with others.
19+
3. Respecting **different viewpoints** and experiences.
20+
4. **Taking responsibility** for our actions and contributions.
21+
5. Gracefully giving and accepting **constructive feedback**.
22+
6. Committing to **repairing harm** when it occurs.
23+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
3324

34-
## Our Responsibilities
3525

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
26+
## Restricted Behaviors
3927

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
28+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
4529

46-
## Scope
30+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
31+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
32+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
33+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
34+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
35+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
36+
7. Behaving in other ways that **threaten the well-being** of our community.
37+
38+
### Other Restrictions
39+
40+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
41+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
42+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
43+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
44+
45+
46+
## Reporting an Issue
47+
48+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
49+
50+
When an incident does occur, it is important to report it promptly. To report a possible violation, email: [info@lucide.dev](mailto:info@lucide.dev)
4751

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
52+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
5453

55-
## Enforcement
5654

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at johnletey@gmail.com. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
55+
## Addressing and Repairing Harm
56+
57+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
58+
59+
1) Warning
60+
1) Event: A violation involving a single incident or series of incidents.
61+
2) Consequence: A private, written warning from the Community Moderators.
62+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
63+
2) Temporarily Limited Activities
64+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
65+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
66+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
67+
3) Temporary Suspension
68+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
69+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
70+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
71+
4) Permanent Ban
72+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
73+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
74+
3) Repair: There is no possible repair in cases of this severity.
75+
76+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
77+
78+
79+
## Scope
80+
81+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
6382

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
6783

6884
## Attribution
6985

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at [http://contributor-covenant.org/version/1/4][version]
86+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
87+
88+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
7289

73-
[homepage]: http://contributor-covenant.org
74-
[version]: http://contributor-covenant.org/version/1/4/
90+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

CONTRIBUTING.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
# Contribution Guidelines
1+
# Contribution Guide
32

43
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
54

@@ -19,13 +18,15 @@ Guidelines for pull requests:
1918
- __Make sure the target of your pull request is the relevant branch__. Most of bug fixes or new feature should go to the `main` branch.
2019
- __Include only related work__. If your pull request has unrelated commits, it won't be accepted.
2120

22-
### Icon Pull Requests
21+
### Contributing Icons
22+
23+
We love contributions of new icons from the community! If you want to contribute new icons, please follow the guidelines below.
2324

2425
#### Guidelines
2526

2627
Please make sure you follow the icon guidelines, that should be followed to keep quality and consistency when making icons for Lucide.
2728

28-
Read it here: [ICON_GUIDELINES](https://lucide.dev/docs/icon-design-guide).
29+
Read it here: [ICON_GUIDELINES](https://lucide.dev/contribute/icon-design-guide).
2930

3031
#### Lucide Studio
3132

@@ -35,15 +36,15 @@ For formatting and adjusting SVG icons, [@jguddas](https://github.com/jguddas) m
3536

3637
Here you can find instructions on how to implement the guidelines with different vector graphics editors:
3738

38-
##### [Adobe Illustrator Guide](https://lucide.dev/docs/illustrator-guide)
39+
##### [Adobe Illustrator Guide](https://lucide.dev/contribute/illustrator-guide)
3940

40-
You can also [download an Adobe Illustrator template](https://github.com/lucide-icons/lucide/blob/main/docs/public/templates/illustrator_template.ai).
41+
You can also [download an Adobe Illustrator template](https://lucide.dev/templates/illustrator_template.ai).
4142

42-
##### [Inkscape Guide](https://lucide.dev/docs/inkscape-guide)
43+
##### [Inkscape Guide](https://lucide.dev/contribute/inkscape-guide)
4344

44-
##### [Figma Guide](https://lucide.dev/docs/figma-guide)
45+
##### [Figma Guide](https://lucide.dev/contribute/figma-guide)
4546

46-
##### [Affinity Designer Guide](https://lucide.dev/guide/design/affinity-designer-guide)
47+
##### [Affinity Designer Guide](https://lucide.dev/contribute/affinity-designer-guide)
4748

4849
#### Submitting Multiple Icons
4950

@@ -191,7 +192,7 @@ Detailed documentation about: installation, guides, packages, design guides etc.
191192

192193
### Icons
193194

194-
All the icons of lucide in SVG format. These will be used as source for all the packages and other distributions for the lucide icons.
195+
All the icons of Lucide in SVG format. These will be used as source for all the packages and other distributions for the Lucide icons.
195196

196197
### Packages
197198

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Lucide is an open-source icon library that provides 1000+ vector (svg) files for
4545

4646
### Figma
4747

48-
The lucide figma plugin.
48+
The Lucide Figma plugin.
4949

5050
Visit [Figma community page](https://www.figma.com/community/plugin/939567362549682242/Lucide-Icons) to install the plugin.
5151

0 commit comments

Comments
 (0)