{"id":15068257,"url":"https://github.com/e-e-e/folderise","last_synced_at":"2026-01-03T16:03:53.031Z","repository":{"id":57239681,"uuid":"60455888","full_name":"e-e-e/Folderise","owner":"e-e-e","description":"An express middleware to create static (or semi-static) websites from a dropbox (or any other) folder.","archived":false,"fork":false,"pushed_at":"2016-06-05T13:08:53.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-25T04:35:08.538Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/e-e-e.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-05T11:03:34.000Z","updated_at":"2021-01-04T11:07:26.000Z","dependencies_parsed_at":"2022-08-29T21:23:18.772Z","dependency_job_id":null,"html_url":"https://github.com/e-e-e/Folderise","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/e-e-e%2FFolderise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/e-e-e%2FFolderise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/e-e-e%2FFolderise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/e-e-e%2FFolderise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/e-e-e","download_url":"https://codeload.github.com/e-e-e/Folderise/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243833464,"owners_count":20355278,"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":[],"created_at":"2024-09-25T01:32:50.798Z","updated_at":"2026-01-03T16:03:53.014Z","avatar_url":"https://github.com/e-e-e.png","language":"JavaScript","readme":"# Folderise\n\nFolderise is a express middleware to create static (or semi-static) websites from a folder of markdown files.\n\nFolderise was developed for Frontyard Project's [website](www.frontyardprojects.org) as a simple way for multiple authors to easily modify the organisations website. We used a shared dropbox folder, so that any changes to the files/folders immediately caused the website to update.\n\n**Guide:**\n\n* Every folder becomes a page. The title of the folder is the name of the page. \n* Any .md file included in a folder will be parsed as Markdown and rendered in alphabetic order.\n* After .md files, if there are other files they will rendered as download links.\n* Any image will be served as an image at the bottom of the page.\n* Any folders, files, or images that begin with a . or an _ will not be rendered.\n* Listings will be alphabetical.\n* The sites pages are cached in _tmp.html files inside each folder.\n* Folderise uses ckokidar to listen for any changes to the website folder and automatically rerenders any changes.\n* template.html is used as the base folder\n\nFolderise is a based on the python static website generator [Folders](https://github.com/sdockray/folders).\n\n**Still to do:**\n\n* enable template to be overriden in settings.\n* include .css or .less\n\n## Install:\n\n```sh \nnpm install folderise\n```\n\nFolderise requires a settings.json file with the following options:\n\n```js\n{\n\t\"port\": /* port for server to listen on */,\n\t\"title\": /*  title of your site */,\n\t\"folder\": /* path/to/folder */,\n\t\"plugins\": [ /* list of plugins */ ]\n}\n```\n\nCheck out the example provided for how to intergate Folderise into your express application.\n\n```js\nvar express\t= require('express');\nvar helmet\t= require('helmet');\nvar bodyParser = require('body-parser');\nvar errorHandler = require('errorhandler');\n\nvar options = require('./settings.json');\nvar folderise = require(\"folderise\")(options);\n\nvar port = options.port;\nvar app = express();\n\napp.use(helmet());\napp.use(helmet.noCache());\napp.use(bodyParser.urlencoded({extended: true}));\napp.use(bodyParser.json());\napp.use(errorHandler());\n\napp.use('/', express.static(options.folder));\napp.use(folderise.middleman() );\napp.get('*', folderise.serve() );\n\napp.listen(port, function() {\n  console.log('Express server listening on port ' + port);\n});\n```\n\n**Note:** If not using any folderise plugins you can increase performance by using Nginx to serve static content.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe-e-e%2Ffolderise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fe-e-e%2Ffolderise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fe-e-e%2Ffolderise/lists"}