Introduction

About

EzGitDoc allows to generate repository documentation projected prototype at https://trolit.github.io/EzGitDoc/. You don't need to install anything as the project is setup and ready to use. Every element's data can be modified after rendering it on page, except image/kbd/linked kbd tables(still with those table types you can quickly change images resolutions to not do it manually for single item). Make prototype of your document, fill in data whenever you want, get output and polish it to your needs. Don't waste time on creating elements from scratch, finding bug or modifying old scheme from different repository. Try EzGitDoc and create documentation you and your viewers would like to read. If you like the idea and want to help with making it more advanced, feel free to join!

Used tools

EzGitDoc

• SortableJS
• Font Awesome icons set
• Font Awesome Animation
• Bootstrap and required dependencies
• MDBootstrap
• FileSaverJS
• FormSpree
• JQuery 3.4.1
• Custom scrollbar plugin
• Modified sidebar snippet
• Bootstrap colorpicker
• Less.js

Documentation

• Docusaurus2
• React Awesome Slider
• React Awesome Button
• SVG icons from Freeicons
• Algolia DocSearch
• Infima

License

Copyright (c) 2020 Paweł Idzikowski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and

associated documentation files (the "Software"), to deal in the Software without restriction,

including without limitation the rights to use, copy, modify, merge, publish, distribute,

sublicense, and/or sell copies of the Software, and to permit persons to whom the Software

is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or

substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING

BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.