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

init: initial website #1

Merged
merged 1 commit into from
Nov 7, 2023
Merged

init: initial website #1

merged 1 commit into from
Nov 7, 2023

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Oct 6, 2023

This is the sources for the website.

Workflow

The motivation behind this workflow is that:

  • We maintain the docs along-side the plugins.
  • But we also won't pollute the git history/activity of svg/svgo with frontend work, so isolate that here.

Note: The steps to run and deploy locally defined in the README assume that the docs have already been merged in svg/svgo! Until that's merged, there won't be a docs/ directory to use.

Once merged, the site can be deployed by creating a release or manually via the GitHub Actions trigger workflow UI.

Inspirations

Future

I'll convert these to issues later once merged:

  • Add a Ways to use SVGO, featuring the SVGOMG, SVGR, webpack, and our CLI.
  • Add a Who's using SVGO section with Bootstrap, Docusaurus via SVGR, Nuxt via IPX, MediaWiki, GitLab, KDE, etc.
  • Improve the Demo section, so each plugin has a tailored demo, rather than a generic SVG. Even better, if we could consider automagically using the SVG from the first test-case, so it's less maintenance. 🤔
  • The Demo section should allow using a local file.
  • The Demo section should allow users to save and preview the SVG in their preferred program.
  • Configure site metadata and Open Graph.
  • Improve the no-JavaScript experience.
    • Color schemes are a mess.
    • Only show the first tab for PluginParams.
    • Show a static server-side rendered demo for PluginParams if possible, otherwise just hide that section.
    • Hide the click to copy UI.
  • Implement a localization workflow.

PageSpeed Insights

Post Merge Tasks

Once the site is deployed, I'd like if the following could be done:

  • Include the svgo.dev link in the project metadata for both svg/svgo and svg/svgo.dev.
  • Verify the svgo.dev domain on the GitHub organization.

Related

@SethFalco SethFalco merged commit 6dd6683 into svg:main Nov 7, 2023
1 check passed
@SethFalco SethFalco deleted the docusaurus branch November 8, 2023 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant