Coder Social home page Coder Social logo

windex's Introduction

Windex - For a bright, shiny index

Windex uses PHP and Apache to style default directory listing index pages. It works directly with Apache's built-in directory mechanism.

Check it out! desandro.com/demo/of-windex/

Authors

Features

  • Styled directory listings. Windex comes with three lovely themes. Add your own theme by creating another CSS file and linking to in header.php.
  • Mobile-optimized view. Shrink any browser to less than 480 pixels wide and you'll have a theme tailored specifically for mobile devices, perfect for the iPhone.
  • Nice default icons.
  • README file contents parsed and appended to pages. Windex looks for README files and adds them to index pages. It will parse documents marked up with Textile (README.textile) or Markdown (README.markdown, README.md, README.mdown). This option can be disabled in config.php.

Windex themes make liberal use of CSS3. Viewing experiences in legacy browsers may differ.

HEADS UP

Enabling directory indexes on a live site can be a serious security risk. Be sure to to install Windex only where you want the child files and folders to be viewable.

Installation

  1. Copy the entire windex folder into your site's directory tree. For instance, if your site's files are in /www/mysite.com, upload this folder to be /www/mysite.com/windex.

  2. Edit windex/config.php and change any configuration options.

  3. If your server runs PHP5, you'll need to change to line 4 of windex/.htaccess to AddHandler application/x-httpd-php5 .php.

  4. Copy and paste the contents of windex.htaccess into a file named .htaccess in the directory where you want to enable Windex. See more on .htaccess below.

  5. Try it out! Browse to a directory that does not contain an index file.

So, to enable Windex on mysite.com/files, your site structure would look like:

mysite.com/
  |
  |-files/
  | |
  | |-.htaccess (has contents of windex.htaccess)
  |
  |-windex/

.htaccess

If you wish to enable Windex in /www/mysite.com/windex/files, you would add the contents windex.htaccess to be in /www/mysite.com/windex/files/.htaccess. If there already is an .htaccess file, DO NOT overwrite the contents, as this code is essential to any CMS you may be running. Instead, add the code from windex.htaccess after the previous code. .htaccess is a hidden configuration file. If this file does not exist you can upload windex.htaccess and then rename it as .htaccess.

If you'd rather not have the windex folder sitting at the top of your site, you'll need to change the filepaths in config.php, all image URLs in the CSS files, and any .htaccess file derived from windex.htaccess

If you wish disable an index page for any child folder, you'll need to upload a .htaccess file in that folder with the following code:

Options -Indexes

No PHP

The no-php branch that does not require PHP. Use this one if your environment does not support PHP, or certain htaccess features. Recommended for Media Temple users.

License

This software is free to use and modify. You may not charge for or sell this software, nor any derivation of it. If you do modify it, we would love to hear about it. Give us a holler and let us know.

Windex is a mod of Indices by Scott Evans.

windex's People

Contributors

bjrn avatar daveatnclud avatar desandro avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.