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

docs: add documentation for all commands #1808

Merged
merged 1 commit into from
Nov 7, 2023
Merged

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Oct 6, 2023

Documentation for SVGO. The goal is to have svg/svgo.dev pull this documentation to display on a website. The documentation is maintained in MDX, which is Markdown with React components.

Some improvements we can consider for future:

  • We have the benefits of reordering nodes/attributes documented twice. We should centralize that information and refer to it.
  • Add more documentation in general.
    • Separately document the CLI, JS API, and browser API.
    • Clarify how to use externally maintained plugins.
    • Expand documentation on existing plugins.

Credit

Special thanks to:

Related

@SethFalco SethFalco merged commit 43df633 into svg:main Nov 7, 2023
5 checks passed
@vanillajonathan
Copy link

Is this documentation built and published anywhere?

@SethFalco
Copy link
Member Author

SethFalco commented Nov 7, 2023

@vanillajonathan

It's hosted on: https://svgo.dev/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants