Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Lucide basics guide on site #1521

Merged
merged 38 commits into from
Oct 3, 2023
Merged

Conversation

ericfennis
Copy link
Member

@ericfennis ericfennis commented Aug 19, 2023

I am writing new documentation for the site with new guides to get started with Lucide and SVG icons.
The guide also contains a lot of basic code examples to show how it works.
I implemented Sandpack from Codesandbox. This is great because you get a little editor where you can make changes and it will render these changes Live. If you want to launch a Codesandbox you can do that with a direct button. This works really well.

This is still far in progress. If you like to help me on this, let me know!

Documentation

I thought of two sections: "basics" and "advanced".

Basics

The basics are really low-level UI programming with SVGs. This shows a lot of the features we builtin in Lucide, and shows how you can modify and style icons using props and CSS.

  • Color, basic how to color Lucide icons
  • Sizing, sizing icons to the favored size.
  • Stroke width, adjust the style of the icon using stroke-width, plus a paragraph about "absolute stroke width"

Advanced (Will be added in another PR)

More advanced way of using Lucide icons in projects. Showing advanced ways how you can use the Lucide library to adjust the Icons to your need.

  • Accessibility, basics about making accessible UI using Lucide icons
  • Global styling, How you can style lucide icons on a global level
  • Animations, How you could use CSS animations to animate SVG paths
  • Filled icons, Not officially supported, but some icons can be filled.
  • Combining icons, How you can nest icons. Creating combinations
  • Dynamic imports, Using dynamic importing icons in projects, (still react only)

@github-actions github-actions bot added 📖 documentation Improvements or additions to documentation 📦 dependencies Pull requests that update a dependency file 🌍 site Has to do something with the Lucide website labels Aug 19, 2023
@ericfennis ericfennis changed the title Add Lucide basics guide on site [WIP] Add Lucide basics guide on site Sep 14, 2023
@ericfennis
Copy link
Member Author

I will add the Advanced section in another PR. So people already can enjoy the new guides.

@ericfennis
Copy link
Member Author

@JanTrichter Thanks a lot! I'm quite happy with this addition. Thanks for your feedback, I've added an editor width percentage, so it should look better now.

@ericfennis
Copy link
Member Author

@JanTrichter Processes your feedback!

code: App,
},
'styles.css': {
code:styles,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to be a common theme here that there is no space between code: and styles ^^

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh tnx, didn't noticed will clean that up!

@ericfennis
Copy link
Member Author

@JanTrichter Thanks for the feedback, I've processed it!

@ericfennis ericfennis merged commit c9101f0 into lucide-icons:main Oct 3, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 dependencies Pull requests that update a dependency file 📖 documentation Improvements or additions to documentation 🌍 site Has to do something with the Lucide website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants