Skip to content

NoesisVision/noesis-docs

Repository files navigation

Noesis Vision - Technical Documentation

This is the technical documentation website for Noesis Vision startup, built using Docusaurus.

🚀 Quick Start

Requirements

  • Node.js 18 or newer
  • npm

Installation

npm install

Development Mode

npm start

The website will be available at http://localhost:3000.

Build

npm run build

Preview Built Website

npm run serve

📚 Project Structure

  • docs/ - Main documentation
  • blog/ - Technical blog
  • src/ - React components and styles
  • static/ - Static files (images, icons)

🌐 GitHub Pages Deployment

The website is automatically deployed to GitHub Pages at: https://noesisvision.github.io/noesis-docs

Automatic Deployment

  1. Push changes to the main branch
  2. GitHub Actions automatically builds and deploys the website
  3. Deployment takes a few minutes

Manual Deployment (optional)

npm run deploy

🔧 Configuration

Main configuration is located in docusaurus.config.ts.

📝 Content Editing

  • Documentation: Edit files in the docs/ folder
  • Blog: Edit files in the blog/ folder
  • Homepage: Edit src/pages/index.tsx

🤝 Contributing

  1. Fork the repository
  2. Create a branch for new functionality
  3. Make changes
  4. Create a Pull Request

📄 License

Copyright © 2024 Noesis Vision. Built with Docusaurus.

About

Documentation of Noesis

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published