{"id":13732897,"url":"https://github.com/foundeo/cfdocs","last_synced_at":"2025-05-08T09:31:13.008Z","repository":{"id":37892850,"uuid":"13303891","full_name":"foundeo/cfdocs","owner":"foundeo","description":"Repository for the cfdocs.org site.","archived":false,"fork":false,"pushed_at":"2025-04-28T14:07:03.000Z","size":11192,"stargazers_count":185,"open_issues_count":96,"forks_count":349,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-04-28T15:26:15.422Z","etag":null,"topics":["cfml","coldfusion","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://cfdocs.org/","language":"ColdFusion","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foundeo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null}},"created_at":"2013-10-03T16:50:50.000Z","updated_at":"2025-04-28T14:07:08.000Z","dependencies_parsed_at":"2024-01-10T23:02:06.731Z","dependency_job_id":"5d709d43-d44d-4c58-a068-fa3124e1de55","html_url":"https://github.com/foundeo/cfdocs","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/foundeo%2Fcfdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundeo%2Fcfdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundeo%2Fcfdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundeo%2Fcfdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foundeo","download_url":"https://codeload.github.com/foundeo/cfdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253036402,"owners_count":21844209,"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":["cfml","coldfusion","hacktoberfest"],"created_at":"2024-08-03T03:00:35.299Z","updated_at":"2025-05-08T09:31:12.997Z","avatar_url":"https://github.com/foundeo.png","language":"ColdFusion","funding_links":[],"categories":["GitHub Repositories"],"sub_categories":[],"readme":"# CFDocs\n\nCFDocs is a community maintained CFML reference tool available at [cfdocs.org](https://cfdocs.org). It features:\n* Hosting on Amazon CloudFront CDN for fast responses around the globe. Sponsored by [Foundeo Inc.](http://foundeo.com).\n* Easy to use urls like: [cfdocs.org/hash](https://cfdocs.org/hash) just hit /tag-name or /function-name.\n* Publicly maintained on [GitHub](https://github.com/foundeo/cfdocs)\n\n[![CI](https://github.com/foundeo/cfdocs/actions/workflows/ci.yml/badge.svg)](https://github.com/foundeo/cfdocs/actions/workflows/ci.yml)\n\n## How reference data is structured\n\nAll of the tag and function documentation are defined in JSON files under [*data/en/functionname.json*](https://github.com/foundeo/cfdocs/tree/master/data/en)  [function example](https://github.com/foundeo/cfdocs/blob/master/data/en/sessioninvalidate.json) [tag example](https://github.com/foundeo/cfdocs/blob/master/data/en/cfhtmltopdf.json).\n\nThis makes the documentation super easy to edit and allows developers to run a local version of the site \"out of the box\" since no database setup is required.\n\n## Running CFDocs locally for dev or pleasure\n\n\n### Running CFDocs Locally\n\nThe cfdocs.org site can run locally very easily thanks to CommandBox.\n\n1. Go download [CommandBox](https://www.ortussolutions.com/products/commandbox) if you do not have it already.\n2. Download this repository and extract it to a folder, or clone it from this repository.\n3. Make a copy of `.env.example` and name it `.env`. This contains required environment variables. [learn more](https://github.com/commandbox-modules/commandbox-dotenv)\n4. Run `box server start` from Command Prompt or Terminal in the root directory.\n\nCommandBox will start an embedded CFML server on port 8411, and you can browse to [http://localhost:8411/](http://localhost:8411/) to view the docs.\n\nIf you don't want to go the CommandBox route you can simply download it and unzip it to a web root and try it out (requires CF10+ or Lucee 4.5+), but you will probably spend more time trying to get it working than the 1-2 minutes it will take to download and learn how to use CommandBox.\n\n## How to contribute\n\nIf you are interested in contributing going I suggest you fork it, see Adam Tuttle's guide: [GitHub tip for your first pull request](https://adamtuttle.codes/blog/2014/your-first-github-pull-request/)\n\nIf you are interested in helping you can just copy a tag or function and write up some documentation. The documentation doesn't need to be super wordy and should not be a copy of Adobe's documentation word for word.\n\nCFDocs.org is meant to be a quick reference so keep it short and sweet. E.g. attribute names / function arguments and one two sentence descriptions.\n\n#### The easy way to edit the docs\n\n1. Browse the [data/en/](https://github.com/foundeo/cfdocs/tree/master/data/en) folder of this repository on GitHub and find the tag or function you want to edit.\n2. Click the edit button (pencil)\n3. Commit\n4. Send a pull request to merge your change with this repository.\n\n#### The better way to edit the docs\n\n1. fork the project to your GitHub account *need help? read this: [GitHub tip for your first pull request](https://adamtuttle.codes/blog/2014/your-first-github-pull-request/)*\n2. clone it locally\n3. make your changes\n4. test it locally using CommandBox (see above)\n4. once you are done you can send a pull request, and I'll merge it into the main repository.\n\n### Not sure what you can contribute?\n\nWe need help expanding existing tag and function documentation. Look through the reference pages till you find one needing more definitions or examples. Also see:\n\n* [Missing Descriptions](https://cfdocs.org/reports/missing-descriptions.cfm)\n* [Missing Examples](https://cfdocs.org/reports/missing-examples.cfm)\n* [Missing Related Links](https://cfdocs.org/reports/missing-related.cfm)\n* [Missing Functions](https://cfdocs.org/reports/todo.cfm)\n\n### JSON File Documentation\n\n    {\n        \"name\":\"nameOfTagOrFunction\",\n        \"type\":\"function|tag\",\n        \"syntax\":\"Tag(arg)|\u003ccftag attr=1\u003e\",\n        \"member\":\"item.memberFunction([args])\",\n        \"script\":\"cftag(attr=1);\",\n        \"returns\":\"void\",\n        \"related\":[\n            \"tag\",\n            \"function\"\n        ],\n        \"description\":\"A short description that describes what the tag or function does.\",\n        \"discouraged\":\"Only add this key if this tag/function is discouraged by the community. Displays a warning.\",\n        \"params\":[\n            {\"name\":\"funcArgNameOrTagAttributeName\", \"description\":\"What it does\", \"required\":true, \"default\":\"false\", \"type\":\"boolean\", \"values\":[]}\n        ],\n        \"engines\":{\n            \"coldfusion\":{\"minimum_version\":\"10\", \"notes\":\"CF Specific Info Here\", \"docs\":\"http://learn.adobe.com/wiki/display/coldfusionen/function\"},\n            \"lucee\":{\"minimum_version\":\"4.5\", \"notes\":\"Lucee Specific Info Here\", \"docs\":\"https://docs.lucee.org/reference/functions/name.html\"},\n            \"railo\":{\"minimum_version\":\"4.1\", \"notes\":\"Railo Specific Here\", \"docs\":\"http://railodocs.org/index.cfm/function/sessionrotate\"}\n        },\n        \"links\":[\n            {\n                \"title\":\"Title of a blog entry that has good info about this.\",\n                \"description\":\"Description of the link\",\n                \"url\":\"http://www.example.com/a/b.cfm\"\n            }\n        ],\n        \"examples\":[\n            {\n                \"title\":\"Name of the code example\",\n                \"description\":\"Description of the code example\",\n                \"code\":\"\u003ccf_examplecodehere\u003e\",\n                \"result\":\"The expected output of the code example\",\n                \"runnable\":true\n            }\n        ]\n    }\n\n\n##### name\n\nThe name of the tag or function, use lowercase.\n\n##### type\n\nEither `function` or `tag` or `listing` a *listing* is how categories are made, they simply contain a `name`, `description`, and a list of `related` items.\n\n##### syntax\n\nThe basic syntax of the tag or function\n\n##### script\n\nFor tags, shows how the tag would be invoked from cfscript.\n\n##### member\n\nFor functions, shows the available member function syntax.\n\n##### returns\n\nThe returntype of a function. Valid options are: `any`, `array`, `binary`, `boolean`, `date`, `function`, `guid`, `numeric`, `query`, `string`, `uuid`, `variableName`, `void`, `xml`. Default value is `void`.\n\n##### related\n\nAn array of tag or function names that are related to this item.\n\n##### description\n\nA short description of the item.\n\n##### discouraged\n\nIf this key exists and has content a warning is displayed stating that the tag or function is discouraged by the CFML community.\n\n##### params\n\nArray of structures containing information about the attributes of a tag, or arguments of a function.\n\n##### engines\n\nCFML engine implementation specific info goes here, for example if it was added in CF10 and Railo 4.1 you can add that in `minimum_version` if something was changed in CF11, you can add notes about what changed. The `docs` key should point to a url for vendor documentation.\n\n##### links\n\nUse this to link to blog entries or other useful related content.\n\n##### examples\n\nShow example code. It is very helpful to readers to use the `result` to show the expected result of the code sample when applicable. This has to be JSON, so  you can to do `\\n` for newline, double quotes must be escaped `\\\"`. The `runnable` is a boolean that determines if the _Run Code_ button shows up next to the example.\n\nWe have an [example JSON utility](https://cfdocs.org/utilities/json/) that can be used to create the JSON by filling out a form.\n\nPlease see the [cfdocs contributor guide](CONTRIBUTING.md) for frequently asked questions.\n\n### IDE Integration\n\nThere are several CFML code editors that utilize the cfdocs repository to provide documentation within the editor.\n\n#### Sublime Text\n\nInstall the CFML Package for Sublime Text 3: \u003chttps://packagecontrol.io/packages/CFML\u003e the plugin will provide inline documentation when hovering the mouse over a tag or function, or when or typing code.\n\n#### Visual Studio Code\n\nInstall the CFML Plugin from KamasamaK: \u003chttps://marketplace.visualstudio.com/items?itemName=KamasamaK.vscode-cfml\u003e\n\n#### VIM\n\nRequires the vim-shell plugin:\n\n```\nfunction! CFDocsSearch()\n   let wordUnderCursor = expand(\"\u003ccword\u003e\")\n   execute 'Open https://cfdocs.org/' . wordUnderCursor\nendfunction\n\ncommand! -nargs=0 CFdocs :call CFDocsSearch()\n```\n\n#### CFEclipse\n\nHit `F1` when the cursor is on a tag or function to be taken to the cfdocs.org doc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundeo%2Fcfdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoundeo%2Fcfdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundeo%2Fcfdocs/lists"}