Shiki 式 Shot 撮 is a sleek Progressive Web App (PWA) designed for creating and sharing stunning code snapshots. Leveraging the power of Shiki syntax highlighting, it combines simplicity and elegance to showcase your code like never before.
- Syntax Highlighting: Utilizes Shiki to provide accurate and aesthetically pleasing code highlighting.
- Progressive Web App: Installable on various devices for a native app-like experience.
- Customizable Themes: Choose from multiple themes to match your preferred coding style.
- Responsive Design: Optimized for both desktop and mobile devices.
- Easy Sharing: Generate shareable links to showcase your code snippets.
To set up the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/bcdipesh/shiki-shot.git cd shiki-shot -
Install dependencies:
npm install
-
Run the development server:
npm run dev
Navigate to
http://localhost:3000to see the application in action.
- Enter your code: Paste or type your code into the editor.
- Select a language: Choose the programming language for proper syntax highlighting.
- Customize the theme: Pick a theme that suits your preference.
- Adjust settings: Modify font size, line numbers, and other display options.
- Generate snapshot: Click the "Capture" button to create a snapshot of your code.
- Share: Use the provided link to share your code snapshot with others.
Contributions are welcome! To get started:
-
Fork the repository.
-
Create a new branch:
git checkout -b feature-name
-
Make your changes.
-
Commit your changes:
git commit -m 'Add new feature' -
Push to the branch:
git push origin feature-name
-
Open a Pull Request.
This project is licensed under the MIT License. See the LICENSE file for more details.
- Shiki: For providing the syntax highlighting engine.
- Vercel: For hosting the live application.
For any inquiries or feedback, please open an issue on the GitHub repository.
Experience the live application here: Shiki 式 Shot 撮