Fluxnova Docs Theme

This repo contains theme elemets for the https://github.com/finos/fluxnova-docs-manual repository.

Install

Clone this repository/branch aside of the fluxnova-docs-manual:

# from the fluxnova-docs-manual directory
cd ..
git clone [email protected]:fluxnova/fluxnova-docs-theme.git
# go into its directory
cd fluxnova-docs-theme
npm i
npm run build

Note: you can clone this repository anywhere, but you may then change the setup.target value of package.json.

Working

After installing (you probably want to have [hugo running as watching server][building-docs]) and then run npm run build from this directory.

Consuming the theme

1. Edit the setup.target value of package.json to point to the theme's root directory in your Hugo project (default: ../fluxnova-docs-manual/themes/fluxnova).
2. Build and update the theme in the target location by either running:
   1. grunt build for building and syncing non-minified assets
   2. Run additionally grunt optimize for building and syncing minified assets

Using git subtree

You can also consume the theme in a project via git subtree:

Adding the latest version of the theme as fluxnova:

git subtree add -P themes/fluxnova [email protected]:fluxnova/fluxnova-docs-theme.git dist --squash

Updating the theme to the latest version:

git subtree pull -P themes/fluxnova [email protected]:fluxnova/fluxnova-docs-theme.git dist --squash

Theme development with Virtualbox

This would be the command to execute in order to make the local development site of fluxnova-docs-manual (see --baseUrl option) available in a virtualbox (typically for IE). Livereload should be deactivate (see --disableLiveReload) if you want to develop for IE9.

hugo --bind="0.0.0.0" --baseUrl="http://10.0.2.2:1313/manual/develop/" -w --disableLiveReload=true server

The development site is then available on http://10.0.2.2:1313/manual/develop/ in your virtualbox guest OS.

Contributing

For any questions, bugs or feature requests please open an issue For anything else please send an email to [email protected].

To submit a contribution:

1. Fork it (https://github.com/finos/fluxnova-docs-theme/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]

License

Copyright 2025 FINOS

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0