{"id":20136231,"url":"https://github.com/lucee/lucee-docs","last_synced_at":"2025-04-08T11:13:36.963Z","repository":{"id":33246581,"uuid":"36890949","full_name":"lucee/lucee-docs","owner":"lucee","description":"Source and build scripts for Lucee's documentation.","archived":false,"fork":false,"pushed_at":"2024-10-29T17:52:19.000Z","size":65101,"stargazers_count":43,"open_issues_count":25,"forks_count":285,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-10-29T22:38:39.606Z","etag":null,"topics":["cfml","coldfusion","dash-docsets","hacktoberfest","lucee"],"latest_commit_sha":null,"homepage":"http://docs.lucee.org","language":"JavaScript","has_issues":false,"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/lucee.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":"2015-06-04T19:29:00.000Z","updated_at":"2024-10-29T21:38:56.000Z","dependencies_parsed_at":"2024-11-06T12:28:27.706Z","dependency_job_id":null,"html_url":"https://github.com/lucee/lucee-docs","commit_stats":{"total_commits":2602,"total_committers":144,"mean_commits":"18.069444444444443","dds":0.6091468101460416,"last_synced_commit":"f95f77ecddd1d95664c7537b40520f9b50809079"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Flucee-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Flucee-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Flucee-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucee%2Flucee-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucee","download_url":"https://codeload.github.com/lucee/lucee-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436095,"owners_count":20776965,"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","dash-docsets","hacktoberfest","lucee"],"created_at":"2024-11-13T21:18:12.727Z","updated_at":"2025-04-08T11:13:31.951Z","avatar_url":"https://github.com/lucee.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lucee documentation source and builder\n\n[![Lucee Docs Builder](https://github.com/lucee/lucee-docs/actions/workflows/main.yml/badge.svg)](https://github.com/lucee/lucee-docs/actions/workflows/main.yml)\n[![Lint](https://github.com/lucee/lucee-docs/actions/workflows/lint.yml/badge.svg)](#lucee-documentation-source-and-builder)\n\nThis repository contains the source and build scripts for creating Lucee's documentation. The website output of the docs can be found at [https://docs.lucee.org](https://docs.lucee.org).\n\nIssues can be reported and tracked at [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD).\n\nFind out more about the project at: [https://docs.lucee.org/docs.html](https://docs.lucee.org/docs.html).\n\n## Build locally\n\n### Prerequisites\n\nThe only optional dependency required is [CommandBox](https://www.ortussolutions.com/products/commandbox).\n\nCommandBox is only required to run the build process via the command line, or if you don't setup a virtual server with an existing local Lucee install.\n\nEnsure that CommandBox is installed and that the `box` command is in your path.\n\n### Building the static documentation output\n\nThe purpose of the structure of the documentation is to allow a human readable and editable form of documentation that can be built into multiple output formats. At present, we have an \"HTML\" builder and a \"Dash docs\" builder, found at `./builders/html` and `./builders/dash` that will build the documentation website and dash docset respectively. The source of the documentation can be found in the `./docs` folder.\n\nTo run the build, execute the `build.sh` or `build.bat` script found in the root of the project, i.e.\n\n\tdocumentation\u003e./build.sh|bat\n\nOnce this has finished, you should find `./builds/html` and `./builds/dash` directories with the website content / dash docsets built.\n\n### Running a server locally\n\nYou have two options\n\n- Create a webserver virtual host with a normal Lucee install, with the virtual host's DocumentRoot set to `/lucee-docs/server`\n- Run a custom docs instance via CommandBox\n\nWe have provided a utility server whose purpose is to run locally to help while developing/writing the documentation. To start it up, execute the `serve.sh` or `serve.bat` script found in the root of the project, i.e.\n\n    documentation\u003e./serve.sh|bat\n\nThis will spin up a server using CommandBox on port 4040 and open it in your browser. You should also see a tray icon that will allow you to stop the server. Changes to the source docs should trigger an internal rebuild of the documentation tree which may take a little longer than regular requests to the documentation.\n\nWhen running locally there are the following URLs available (these URLs below are for a CommandBox instance, substitute them with the URL for your virtual host if appropriate)\n\n* [Lucee documentation home](http://127.0.0.1:4040/)\n* [Build all documentation](http://127.0.0.1:4040/build_docs/all/)\n* [Build HTML documentation](http://127.0.0.1:4040/build_docs/html/)\n* [Build dash documentation](http://127.0.0.1:4040/build_docs/dash/)\n* [Import any new tags or functions](http://127.0.0.1:4040/build_docs/import/)\n* [View static HTML docs](http://127.0.0.1:4040/static/) (you need to have built the HTML documentation first)\n\n## Working with the bundled JS and CSS files\n\nThe build process for the JS and CSS bundles are found under `/builders/html/assets` and uses Sass and [Grunt](https://gruntjs.com/).\n\nJust run npm install, then run grunt.\n\nAfter you have made everything more beautiful via CSS, or added some funky new interactivity via JavaScript,\nto publish a new build of the bundles, you'll need to update `variables.assetBundleVersion` in both Application.cfc and Gruntfile.js,\nas the docs are statically deployed via Cloudfront and versioning of these files is required to break caching.\n\n## Contributing\n\nThere is a lot of work to do, and we appreciate contribution in all forms. The issues list can be found and expanded upon here: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD)\n\nAsk questions or post suggestions over on the [Lucee mailing List](https://dev.lucee.org/c/documentation) under the documentation category.\n\nMore information on how the documentation is built and formatted can be found at [https://docs.lucee.org/docs.html](https://docs.lucee.org/docs.html).\n\nThe workflow for contributions is:\n\n* Submit the contributor's agreement: \u003chttps://docs.lucee.org/guides/get-involved/contributing-contributors-agreement.html\u003e\n* Fork lucee-docs on GitHub.\n* Make your changes in a new feature branch.\n* Push your changes to your GitHub repo.\n* Create a pull request.\n\n### Raise issues and suggestions\n\nIssues and suggestions are always welcome (though pull requests are preferred!). Please use the issue tracker: [https://luceeserver.atlassian.net/projects/LD](https://luceeserver.atlassian.net/projects/LD).\n\n### License\n\nThe project is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucee%2Flucee-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucee%2Flucee-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucee%2Flucee-docs/lists"}