KariIndexer.Net 1.0.8

<div id="top" />

<br /> <div align="center"> <a href="https://github.com/karafra/html-indexer"> <img src="img/logo.png" alt="Logo" width="80" height="80"> </a>

<h3 align="center">Kari indexer</h3>

<p align="center"> Simple folder indexer with html output <br /> <a href="https://github.com/karafra/html-indexer/wiki"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/karafra/html-indexer/issues">Report Bug</a> · <a href="https://github.com/karafra/html-indexer/issues">Request Feature</a> </p> </div>

<details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <li><a href="#installation">Installation</a></li> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> </ol> </details>

About The Project

<div align="center">

</div>

Simple folder indexer with html output file, very simple and highly customizable. <p align="right">(<a href="#top">back to top</a>)</p>

Built With

• .Net 6.0
• Razor
• MiniRazor
• Bootstrap (Icons)
• GithubActions (CI)
• XUnit

<p align="right">(<a href="#top">back to top</a>)</p>

Getting Started

Installation

1. Install package

   $ dotnet add <Project> package KariIndexer.Net 
   

2. Enjoy 😊

<p align="right">(<a href="#top">back to top</a>)</p>

Usage

public class Program
{
  public static async Task Main(string[] args)
  {
    var index = new IndexContext("../../img/", "index.html");
    await FolderIndexer.CreateWriter(index).GenerateIndex();
  }
}

For more examples, please refer to the Documentation

<p align="right">(<a href="#top">back to top</a>)</p>

Roadmap

• Coverage
• Add CLI module

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>

License

Distributed under the Apache 2.0 License. See license for more information.

<p align="right">(<a href="#top">back to top</a>)</p>

Contact

Your Name - @karafra - dariusKralovic@protonmail.com

Project Link: https://github.com/karafra/html-indexer

<p align="right">(<a href="#top">back to top</a>)</p>