docs: add custom theme - Githubissues

vuestorefront / vue-storefront

Alokai is a Frontend as a Service solution that simplifies composable commerce. It connects all the technologies needed to build and deploy fast & scalable ecommerce frontends. It guides merchants to deliver exceptional customer experiences quickly and easily.

https://www.alokai.com

MIT License

10.59k stars 2.08k forks source link

docs: add custom theme #6781

Closed mattmaribojoc closed 2 years ago

mattmaribojoc commented 2 years ago

Add VSF theme to core documentation:

Preview URL - https://roaring-treacle-02c06c.netlify.app/v2/

Description

Adds a custom Vuepress theme to improve the UX of our docs. This will eventually be added for all of the integrations.

Motivation and Context

Bringing consistency to the documentation.

Screenshots:

Preview Link: https://roaring-treacle-02c06c.netlify.app/v2/

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[ X] I have read the CONTRIBUTING document.

Changelog

[ X] I have updated the Changelog (V1) v2 and mentioned all breaking changes in the public API.
[ X] I have documented all new public APIs and made changes to existing docs mentioning the parts I've changed so they're up to date.

Tests

[ ] I have written test cases for my code
[ ] I have tested my Pull Request on production build and (to my knowledge) it works without any issues
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

I tested manually my code, and it works well with both:
[ ] Default Theme
[ ] Capybara Theme

Code standards

[ ] My code follows the code style of this project.
[ ] I have followed naming conventions

Docs

[ X ] My change requires a change to the documentation.
[ X ] I have updated the documentation accordingly.