Generates static index file for Github-Pages - Generate Index file for your code base (Repo structure) in one command.
So you have a code base 👨💻 and want to add that to github pages 📄 or attach to your existing 🌐 site, wether you want a simple markdown file or simple html page with simple lists or card or a complex header-footer for your codebase element. GenIndex will do it for you. GenIndex can generate index pages for your code base with a simple command no matter how complex your repo structure is. Similer to this 👇
- Can generate index files in HTML format or Markdown format
- Markdown can be customized with available options such as type of list 📃 to be shown.
- HTML indeces can be fully customized from using prebuild options to using custom template to give look and feel of your 🌐 website
- Easy to use
- Generate pages can be added to existing site
- And many more more customizations, such as title,Override behaviour etc.
GenIndex can be used by to ways:
- As a python module by importing to your program. Check 👉 here
- As script By running directly from Terminal. Check 👉 here
Contributions ❤ to this repo are fully welcomed. Contributions can be done in the form of:
- Page or item templates
- Improvement in GenIndex Working. Make it more flexible to accomodate changes.
- Suggestions for improvements
- If you find this helpful star repo and share with friends
- Mail 💌 at newsandeepat@gmail.com
- Open an issue 🐛