{"id":16805244,"url":"https://github.com/chuckhoupt/autoindex_strapdown","last_synced_at":"2025-03-22T02:31:23.832Z","repository":{"id":16651684,"uuid":"19407113","full_name":"chuckhoupt/autoindex_strapdown","owner":"chuckhoupt","description":"Easily add Markdown README/HEADERs to Apache's directory indexes, rendered by Strapdown.js","archived":false,"fork":false,"pushed_at":"2023-12-12T15:10:00.000Z","size":300,"stargazers_count":36,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-18T07:11:52.407Z","etag":null,"topics":["apache","htaccess","markdown","mod-autoindex","strapdown-js"],"latest_commit_sha":null,"homepage":"https://ais.habilis.net","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chuckhoupt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-03T16:25:23.000Z","updated_at":"2023-08-01T13:36:49.000Z","dependencies_parsed_at":"2024-10-28T18:02:56.095Z","dependency_job_id":null,"html_url":"https://github.com/chuckhoupt/autoindex_strapdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckhoupt%2Fautoindex_strapdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckhoupt%2Fautoindex_strapdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckhoupt%2Fautoindex_strapdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chuckhoupt%2Fautoindex_strapdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chuckhoupt","download_url":"https://codeload.github.com/chuckhoupt/autoindex_strapdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244898031,"owners_count":20528331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache","htaccess","markdown","mod-autoindex","strapdown-js"],"created_at":"2024-10-13T09:47:35.685Z","updated_at":"2025-03-22T02:31:23.544Z","avatar_url":"https://github.com/chuckhoupt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Autoindex-Strapdown Read-Me\n---------------------------\n\n\u003ca id=readme\u003e\u003c/a\u003e\n[Autoindex-Strapdown] enhances Apache's [mod_autoindex] directory listings with\n[Markdown] README and HEADER files rendered by [Strapdown.js]. Setup GitHub-like\ndirectory documentation with just Apache!\n\n#### Screenshot Before and After\n\n![Before and After Autoindex-Strapdown](pic/before-after.png \"Before: ugly, pixilated, cramped, boring.\nAfter: sleek, vectorized, spacious, lickable.\")\n\n### Quick Start\n\n**Simply copy the following into a directory's .htaccess file -- That's All!**\n\u003cbr\u003eThen add a README.md or HEADER.md files and enjoy.\n\n```ApacheConf\n# Apache Autoindex Directives\nOptions +Indexes\nIndexOptions FancyIndexing HTMLTable SuppressRules\nIndexOptions IconsAreLinks ScanHTMLTitles NameWidth=* DescriptionWidth=*\n\n# Autoindex-Strapdown Directives\nAddType text/plain .md\nHeaderName HEADER.md\nReadmeName README.md\n\n# Customize by setting theme and title\nIndexHeadInsert \"\u003cscript\u003econf = {theme: 'bootstrap', title: ''};\u003c/script\u003e \\\n\u003cscript src='https://ais.habilis.net/autoindex_strapdown.js'\u003e\u003c/script\u003e \\\n\u003clink rel='stylesheet' href='https://ais.habilis.net/autoindex_strapdown.css'\u003e\"\n\n# Icons using Bootstrap's Glyphicon set\nDefaultIcon https://ais.habilis.net/icons/glyphicon-file.svg\nAddIcon https://ais.habilis.net/icons/blank.svg ^^BLANKICON^^\nAddIcon https://ais.habilis.net/icons/glyphicon-folder-open.svg ^^DIRECTORY^^\nAddIcon https://ais.habilis.net/icons/glyphicon-circle-arrow-up.svg ..\nAddIconByType (TXT,https://ais.habilis.net/icons/glyphicon-file.svg) text/*\nAddIconByType (IMG,https://ais.habilis.net/icons/glyphicon-picture.svg) image/*\nAddIconByType (SND,https://ais.habilis.net/icons/glyphicon-music.svg) audio/*\nAddIconByType (VID,https://ais.habilis.net/icons/glyphicon-film.svg) video/*\n```\n\nCustomize by setting the `theme` or `title` configuration parameter on the first line of\nthe `IndexHeadInsert` directive. For example:\n\n`IndexHeadInsert \"\u003cscript\u003econf = {theme: 'cyborg', title: 'My Robot Pics'};\u003c/script\u003e \\`\n\nSee the list of [themes available from Strapdown.js][Strapdown.js].\n\n### Self-Hosting\n\nFor simplicity, the example above uses assets hosted at `ais.habilis.net`. To install on your\nown host, git-clone Autoindex-Strapdown (include sub-modules):\n\n```\ngit clone --recurse-submodules https://github.com/chuckhoupt/autoindex_strapdown.git\n```\n\nThen adjust the htaccess directives to point at local URLs for the Javascript, CSS and icons.\nAdd the extra conf option `strapdown` to self-host Strapdown. I.e.:\n\n`conf = {theme: 'bootstrap', title: '', strapdown: '/sd/strapdown.js'}`\n\nFor a concrete example, see the [htaccess-selfhost](htaccess-selfhost) file which expects\nAutoindex-Strapdown to be installed on the host at the URL `/autoindex_strapdown/`.\n\n### Background\n\nSince time immemorial, the Apache web server has had the ability to serve up directory\nlistings (indexes), optionally augmented with text or HTML read-me and header files.\nGitHub partially emulates Apache's auto-indexes with READMEs, but enhances it by adding\nMarkdown formatting -- the prefect compromise between plain text and HTML.\n\nIn a sense, Autoindex-Strapdown is an attempt to backport GitHub's enhanced emulation of\nApache mod_autoindex back to Apache.\n\n[Autoindex-Strapdown]: https://ais.habilis.net\n[mod_autoindex]: https://httpd.apache.org/docs/current/mod/mod_autoindex.html\n[Markdown]: https://daringfireball.net/projects/markdown/\n[Strapdown.js]: https://github.com/arturadib/strapdown\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchuckhoupt%2Fautoindex_strapdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchuckhoupt%2Fautoindex_strapdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchuckhoupt%2Fautoindex_strapdown/lists"}