wellercs / lucee-docs

Source and build scripts for Lucee's documentation.

Lucee documentation source and builder

This repository contains the source and build scripts for creating Lucee's documentation. The website output of the docs can be found at http://docs.lucee.org.

Issues can be reported and tracked at https://luceeserver.atlassian.net/projects/LD.

Find out more about the project at: http://docs.lucee.org/docs.html.

Build locally

Prerequisites

The only dependency required is CommandBox. Ensure that commandbox is installed and that the box command is in your path.

Building the static documentation output

The 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.

To run the build, execute the build.sh file found in the root of the project, i.e.

documentation>./build.sh

Once this has finished, you should find ./builds/html and ./builds/dash directories with the website content / dash docsets built.

Running a server locally

We have provided a utility server who's purpose is to run locally to help while developing/writing the documentation. To start it up, execute the serve.sh file found in the root of the project, i.e.

documentation>./serve.sh

This 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.

Note: there is currently no batch file equivalent for Windows. If you are running on windows, it should be fairly trivial to copy and adapt what is found in the .sh file (please let us know if you get this working).

Contributing

There 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

More information on how the documentation is built and formatted can be found at http://docs.lucee.org/docs.html.

Raise issues and suggestions

Issues and suggestions are always welcome (though pull requests are preferred!). Please use the issue tracker: https://luceeserver.atlassian.net/projects/LD.

License

The project is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.