Skip to content

Latest commit

 

History

58 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

πŸš€ Deploy 🚚 Release 🏷️ Tag License: MIT Made With Docusaurus

πŸ“š My personal Wiki


This repository contains the source code for my personal wiki website.
A website built with Docusaurus
πŸ”— wiki.horia.delicoti.com

πŸ’‘ Motive

A digital garden where I collect, organize, and share everything I learn about technology, DevOps, programming, and beyond.

🧠 About

The content is defined in Markdown files located in the docs/ directory. The site is built with Docusaurus and lives on GitHub Pages.

πŸš€ Getting Started

βš™οΈ Prerequisites

πŸ’» Installation

Clone the repository:

git clone https://github.com/horia-delicoti/wiki.git
cd wiki

Install dependencies:

npm install

πŸ§ͺ Local Development

Starts the development server

npm start β†’ docusaurus start

Features:

  • Hot Reloading: Automatically refreshes when you make changes to your source files
  • Error Overlay: Displays helpful error messages in the browser when something goes wrong.
  • Debugging: Provides detailed stack traces and debugging information.
  • Faster Build Times: Optimized for quick feedback during development.

Use case: When you're actively developing and want to see changes immediately without manually refreshing the browser.

npm start

πŸ—οΈ Production Build

Bundles your website into static files for production

npm run build β†’ docusaurus build

Features:

  • Static Site Generation (SSG): Pre-renders all pages at build time for optimal performance and SEO
  • Code Splitting: Automatically splits JavaScript bundles by routes and components for faster loading
  • Tree Shaking: Removes unused code from the final bundle to reduce file sizes
  • Minification: Compresses HTML, CSS, and JavaScript files for optimal delivery
  • Asset Optimization: Optimizes images and static assets with content hashing for cache busting
  • Bundle Analysis: Creates optimized chunks with intelligent caching strategies
  • Sitemap Generation: Automatically creates sitemap.xml and RSS feeds for search engines
  • Service Worker: Generates offline functionality files (if enabled)

Use case: Preparing your website for deployment with maximum performance optimizations and SEO benefits.

npm run build
Serves the built website locally.

npm run serve β†’ docusaurus serve

Features:

  • Serves the optimized production build of your website.
  • No hot reloading; serves static files as they are. You need to rebuild if you make changes.
  • Production optimizations: Minification, code splitting, and other optimizations for better performance.
  • Exactly what the users will see in production.

Use case: Testing your production build locally before deploying.

npm run serve

πŸš€ Deployment

Deploys the website to GitHub Pages

npm run deploy β†’ docusaurus deploy

Technical Process:

  • Automated Build: Automatically runs docusaurus build to generate production files
  • Git Integration: Creates or switches to the gh-pages branch in your repository
  • File Deployment: Pushes the entire build/ directory contents to the gh-pages branch
  • GitHub Pages Activation: Automatically configures GitHub Pages to serve from the gh-pages branch
  • Domain Configuration: Supports custom domains via CNAME file generation
  • History Management: Maintains deployment history and rollback capabilities
  • CI/CD Compatible: Works seamlessly with GitHub Actions and other CI/CD pipelines

Prerequisites:

  • Repository must be configured with GitHub Pages settings
  • organizationName and projectName must be set in docusaurus.config.js
  • Git remote must be properly configured and authenticated

Use case: Automated deployment to GitHub Pages with zero-downtime and built-in rollback support.

USE_SSH=true npm run deploy # Deploy using SSH authentication
GIT_USER=<Your GitHub username> npm run deploy # Deploy using HTTPS authentication

πŸ“Έ Screenshot

🌎 Wiki Preview

Wiki Preview Photo

πŸ”§ Troubleshooting

πŸ”§ Port already in use

# Kill process using port 3000
lsof -ti:3000 | xargs kill -9

πŸ”§ Build fails

# Clear npm cache
npm cache clean --force

# Remove node_modules and reinstall
rm -rf node_modules package-lock.json
npm install

πŸ”§ Deployment issues

  • Ensure your GitHub repository has Pages enabled
  • Check that organizationName and projectName match your GitHub settings
  • Verify your authentication method (SSH vs HTTPS)

🀝 Contributing

This is a personal knowledge wiki. Feel free to fork the repository and adapt it for your own wiki page. No contributions or issues are needed for this project.

πŸ™Œ Attributions

contributors badge

🫑 Acknowledgements

πŸ“š Resources

βš™οΈ Build & Utility Tools

  • Docusaurus - An open-source static site generator that makes it easy to build and maintain open source project websites.
  • Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • npm - A package manager for JavaScript.
  • Shields.io - A service that provides a simple way to create consistent and customizable badges for open source projects.

βš–οΈ License

This project is licensed under the MIT License. See the LICENSE file for details.

Β© Horia Delicoti 2025
Licensed under MIT

Happy exploring πŸ™‚

About

πŸ“š Digital notebook to document and organize my knowledge, ideas and resources.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages