Overview:
Yoshino is a development framework that allows developers to create and share themes for their projects. It is inspired by Hexo and offers similar functionalities. Yoshino provides a range of components and effects that can be customized and used in projects. It also supports TypeScript and provides d.ts files to aid in development.
Features:
- Develop with TypeScript: Yoshino supports TypeScript and provides d.ts files, making development faster and more efficient.
- OFA and AFO Concept: Yoshino follows the concept of “one for all” and “all for one”, allowing developers to standardize component outputs based on their project’s UI.
- Helpers: Yoshino offers a variety of helper components that provide useful effects and functionality.
- Ripple: Yoshino includes a Ripple component that adds a ripple effect to elements when clicked.
- Transitions: Yoshino provides transition components that can be used to add smooth animations to elements.
- Icon component: Yoshino’s Icon component is based on archer-svgs and can be loaded on demand. It only loads the necessary .svg files.
Installation:
To install Yoshino, follow these steps:
- Use npm to install Yoshino:
npm install yoshino-cli
- Generate a theme template using Yoshino-cli:
yoshino-cli generate theme-template
Customize the theme template as desired.
Upload the theme to GitHub.
Fork the Yoshino repository and edit the
docs/pages/themes/index.tsx
file to add information about your theme.Create a pull request to merge your changes.
Search for your theme on the theme-site once the changes are merged.
Summary:
Yoshino is a development framework that allows developers to create and share themes for their projects. It offers a range of components and effects, supports TypeScript, and follows the concept of “one for all” and “all for one”. By customizing the theme template generated by Yoshino-cli, developers can create unique themes and share them with others. Yoshino aims to provide a similar experience to Hexo and offers additional features and components to enhance project development.