-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release-10.2.3' into stable
- Loading branch information
Showing
435 changed files
with
33,044 additions
and
10,435 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,18 @@ | ||
component output=false { | ||
this.mappings[ "/preside" ] = ExpandPath( "../../" ); | ||
component { | ||
this.name = "presideDocumentationBuilder-" & Hash( GetCurrentTemplatePath() ); | ||
|
||
this.cwd = GetDirectoryFromPath( GetCurrentTemplatePath() ) | ||
|
||
this.mappings[ "/api" ] = this.cwd & "api"; | ||
this.mappings[ "/builders" ] = this.cwd & "builders"; | ||
this.mappings[ "/docs" ] = this.cwd & "docs"; | ||
this.mappings[ "/import" ] = this.cwd & "import"; | ||
this.mappings[ "/builds" ] = this.cwd & "builds"; | ||
this.mappings[ "/preside" ] = ExpandPath( this.cwd & "../../" ); | ||
|
||
public boolean function onRequest( required string requestedTemplate ) output=true { | ||
include template=arguments.requestedTemplate; | ||
|
||
return true; | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# PresideCMS documentation source and builder | ||
|
||
[![Build Status](https://travis-ci.org/pixl8/preside-docs.svg?branch=master)](https://travis-ci.org/pixl8/preside-docs) | ||
|
||
This directory contains the source and build scripts for creating Preside CMS's documentation. The website output of the docs can be found at [http://docs.presidecms.com](http://docs.presidecms.com). | ||
|
||
## Build locally | ||
|
||
### Prerequisites | ||
|
||
The only dependency required is [CommandBox](http://www.ortussolutions.com/products/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). | ||
### License | ||
|
||
The project is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/). |
Oops, something went wrong.