Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.44 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.44 KB

TileFusion Documentation

This repository contains the documentation website for the TileFusion library. The documentation is built using Jekyll and hosted on GitHub Pages.

🚀 Getting Started

Prerequisites

  • Ruby 2.5 or higher
  • Bundler
  • Jekyll

Local Development

  1. Clone this repository:

    git clone https://github.com/TiledTensor/tilefusion-docs
cd tilefusion-docs

  2. Install dependencies:

    bundle install

  3. Start the local server:

    bundle exec jekyll serve --baseurl ""

  4. Visit http://localhost:4000 in your browser to view the documentation.

📁 Repository Structure

  • docs/ - Main documentation content
  • _includes/ - Reusable Jekyll components
  • _layouts/ - Page layout templates
  • assets/ - Static assets (images, CSS, JavaScript)
  • _config.yml - Jekyll configuration file

🤝 Contributing

We welcome contributions to improve the documentation! Please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Submit a pull request

📝 License

This documentation is licensed under the same license as the TileFusion library. See the LICENSE file for details.

🔗 Links