Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chuckhoupt/autoindex_strapdown
Easily add Markdown README/HEADERs to Apache's directory indexes, rendered by Strapdown.js
https://github.com/chuckhoupt/autoindex_strapdown
apache htaccess markdown mod-autoindex strapdown-js
Last synced: 4 months ago
JSON representation
Easily add Markdown README/HEADERs to Apache's directory indexes, rendered by Strapdown.js
- Host: GitHub
- URL: https://github.com/chuckhoupt/autoindex_strapdown
- Owner: chuckhoupt
- License: mit
- Created: 2014-05-03T16:25:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T15:10:00.000Z (about 1 year ago)
- Last Synced: 2024-10-14T09:47:39.179Z (4 months ago)
- Topics: apache, htaccess, markdown, mod-autoindex, strapdown-js
- Language: JavaScript
- Homepage: https://ais.habilis.net
- Size: 293 KB
- Stars: 36
- Watchers: 6
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Autoindex-Strapdown Read-Me
---------------------------
[Autoindex-Strapdown] enhances Apache's [mod_autoindex] directory listings with
[Markdown] README and HEADER files rendered by [Strapdown.js]. Setup GitHub-like
directory documentation with just Apache!
#### Screenshot Before and After
### Quick Start
**Simply copy the following into a directory's .htaccess file -- That's All!**
Then add a README.md or HEADER.md files and enjoy.
```ApacheConf
# Apache Autoindex Directives
Options +Indexes
IndexOptions FancyIndexing HTMLTable SuppressRules
IndexOptions IconsAreLinks ScanHTMLTitles NameWidth=* DescriptionWidth=*
# Autoindex-Strapdown Directives
AddType text/plain .md
HeaderName HEADER.md
ReadmeName README.md
# Customize by setting theme and title
IndexHeadInsert "conf = {theme: 'bootstrap', title: ''}; \
\
"
# Icons using Bootstrap's Glyphicon set
DefaultIcon https://ais.habilis.net/icons/glyphicon-file.svg
AddIcon https://ais.habilis.net/icons/blank.svg ^^BLANKICON^^
AddIcon https://ais.habilis.net/icons/glyphicon-folder-open.svg ^^DIRECTORY^^
AddIcon https://ais.habilis.net/icons/glyphicon-circle-arrow-up.svg ..
AddIconByType (TXT,https://ais.habilis.net/icons/glyphicon-file.svg) text/*
AddIconByType (IMG,https://ais.habilis.net/icons/glyphicon-picture.svg) image/*
AddIconByType (SND,https://ais.habilis.net/icons/glyphicon-music.svg) audio/*
AddIconByType (VID,https://ais.habilis.net/icons/glyphicon-film.svg) video/*
```
Customize by setting the `theme` or `title` configuration parameter on the first line of
the `IndexHeadInsert` directive. For example:
`IndexHeadInsert "conf = {theme: 'cyborg', title: 'My Robot Pics'}; \`
See the list of [themes available from Strapdown.js][Strapdown.js].
### Self-Hosting
For simplicity, the example above uses assets hosted at `ais.habilis.net`. To install on your
own host, git-clone Autoindex-Strapdown (include sub-modules):
```
git clone --recurse-submodules https://github.com/chuckhoupt/autoindex_strapdown.git
```
Then adjust the htaccess directives to point at local URLs for the Javascript, CSS and icons.
Add the extra conf option `strapdown` to self-host Strapdown. I.e.:
`conf = {theme: 'bootstrap', title: '', strapdown: '/sd/strapdown.js'}`
For a concrete example, see the [htaccess-selfhost](htaccess-selfhost) file which expects
Autoindex-Strapdown to be installed on the host at the URL `/autoindex_strapdown/`.
### Background
Since time immemorial, the Apache web server has had the ability to serve up directory
listings (indexes), optionally augmented with text or HTML read-me and header files.
GitHub partially emulates Apache's auto-indexes with READMEs, but enhances it by adding
Markdown formatting -- the prefect compromise between plain text and HTML.
In a sense, Autoindex-Strapdown is an attempt to backport GitHub's enhanced emulation of
Apache mod_autoindex back to Apache.
[Autoindex-Strapdown]: https://ais.habilis.net
[mod_autoindex]: https://httpd.apache.org/docs/current/mod/mod_autoindex.html
[Markdown]: https://daringfireball.net/projects/markdown/
[Strapdown.js]: https://github.com/arturadib/strapdown