hirusha-adi/hirusha

Personal Website | Hirusha Adikari

 Built with 🦖Docusaurus

🖥 Online Preview

👋 Introduction

This website is powered by Docusaurus 3, a modern static website generator designed for creating easy-to-navigate documentation sites.

This is a fork of kuizuo/blog, made by 愧怍

✨ Improved Features

✍️ Markdown - Easy to write
🎨 Beautiful - Neat and beautiful
🖥️ PWA - Supports PWA, installable, available offline
💯 SEO - Search engine optimization, easy to index
📊 Google Analytics - Support Google Analytics
🔎 Full text search - Support Local Search
🗃️ Blog View - Different blog views, list, grid, card
🌈 Resource Navigation - Collect and share useful and interesting resources
📦 Project Display - Display your projects, can be used in your portfolio

Changes made by 愧怍 (kuizo) can be found here

Changes that I made:

Switched from alglolia search to docusaurus-plugin-search-local
removed Chinese, the site is English only.
changed /friends to /contributions
changed /resources to /recommended-tools
and, changed the structure of /docs/ and /blog/ with sidebars.ts to suite my personal needs

📥 Installation

Before you get started with our website, follow these installation steps to ensure a smooth setup.

Step 1: Clear Existing Cache

pnpm cache clean --force

This command helps ensure that you have a clean slate before installing the required dependencies.

Step 2: Install Dependencies

pnpm install

This command installs all the necessary packages and dependencies for our website.

👩‍💻 Local Development

To work on our website locally and see your changes in real-time, follow these steps:

pnpm start

This command starts a local development server and automatically opens your default web browser. Most changes are reflected live without the need to restart the server. It's an efficient way to test and make improvements to our website.

📦 Deployment

To deploy our website, follow these steps:

Step 1: Open Command Prompt

Open your command prompt or terminal.

Step 2: Set Git User

Set your Git user credentials using the following command:

set GIT_USER=hirusha-adi

Use the command below if you are using linux:

export GIT_USER="hirusha-adi"

Replace hirusha-adi with your actual Git username.

Step 3: Deploy to GitHub Pages

Execute the following command to build the website and push it to the gh-pages branch:

npx docusaurus deploy

pnpm deploy - gave an error

>pnpm deploy
 ERR_PNPM_CANNOT_DEPLOY  A deploy is only possible from inside a workspace

If you are using GitHub Pages for hosting, this command is a convenient way to make your website accessible to the public.

By following these steps, you can easily set up, develop, and deploy our website using Docusaurus 3 & pnpm.

Errors

This diff contains a change in line endings from 'LF' to 'CRLF'.

simply run:
```
git config core.autocrlf input
```

hirusha-adi / hirusha