https://github.com/devtronic/doc-index

A simple index page for sami/sami generated documentations
https://github.com/devtronic/doc-index

Last synced: 5 months ago
JSON representation

A simple index page for sami/sami generated documentations

• Host: GitHub
• URL: https://github.com/devtronic/doc-index
• Owner: devtronic
• License: mit
• Created: 2017-08-05T09:22:40.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-05T10:02:11.000Z (almost 9 years ago)
• Last Synced: 2024-12-30T21:29:13.079Z (over 1 year ago)
• Language: PHP
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documentation Index Page

Live Demo: [https://docs.developer-heaven.de/](https://docs.developer-heaven.de/)

## Installation

`$ composer create-project devtronic/doc-index`

## Configuration

Create a user.txt and put your GitHub username in it

## Usage

Simply put your documentations under `docs/USERNAME/REPO_NAME/PRIMARY_BRANCH_NAME` and the list

shows a link to the folder.