karafra/html-indexer

:seedling: Simple HTML folder indexer :card_file_box:

Kari indexer

Simple folder indexer with html output
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. Installation
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact

About The Project

Simple folder indexer with html output file, very simple and highly customizable.

(back to top)

Built With

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

(back to top)

Getting Started

Installation

1. Install package

   $ dotnet add <Project> package KariIndexer.Net 

2. Enjoy 😊

(back to top)

Usage

using HtmlIndexer;

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

(back to top)

Roadmap

• Coverage
• Add CLI module

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

(back to top)

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

(back to top)

License

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

(back to top)

Contact

Your Name - @karafra - dariusKralovic@protonmail.com

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

(back to top)