Skip to content

Syqlorix/syqlorix.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Syqlorix Documentation

Syqlorix Logo

This repository contains the source code for the official documentation website for Syqlorix.

🚀 View the Live Documentation Site

About This Repository

This site serves as the official user guide, API reference, and documentation hub for the Syqlorix Python framework. While the main project provides the Python package, this repository contains the HTML, CSS, and JavaScript that powers the user-facing documentation.

The site is built as a single-page application that dynamically loads and renders markdown files to provide a fast and smooth user experience.

Key Links


Technology Stack

This is a custom-built static site using modern web technologies, designed to be fast, responsive, and easy to maintain.

  • HTML5
  • Tailwind CSS for all styling and layout.
  • Vanilla JavaScript (ES6+) for all client-side functionality, including:
    • Collapsible Sidebar Navigation
    • Dark/Light Theme Management
    • Dynamic Page Loading
  • marked.js for parsing markdown files into HTML on the fly.
  • Prism.js for beautiful and accurate syntax highlighting in code blocks.

About

official documentation and comprehensive examples for the Syqlorix Python package.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •