https://github.com/finbourne/luminesce-docs

https://github.com/finbourne/luminesce-docs

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/finbourne/luminesce-docs
• Owner: finbourne
• Created: 2021-04-30T12:04:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T13:41:03.000Z (7 months ago)
• Last Synced: 2024-06-24T15:19:54.871Z (7 months ago)
• Language: JavaScript
• Size: 66.4 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
image::./resources/Finbourne_Logo_Teal.svg[LUSID_by_Finbourne]

= Luminesce Documentation

== Installation

To build these docs locally you will need link:https://nodejs.org/en/download/package-manager/[Node & NPM^] installed.  Antora requires Node version 10 or higher.

To install the dependencies run:

[source,sh]

----

npm install

----

== Live Preview

To preview the docs run:

[source,sh]

----

npm start

----

This will build a set of HTML files in `build/site` and then serve them through an express server at http://localhost:8000.

The dev script will also listen for changes and automatically rebuild the files automatically.

You'll still need to refresh the page to view the changes.