Updated indentation for better formatting and disabled hrefAsBlank
6 files changed
tree: 474002444517696aae2172d8870742859d7fdf47
  1. .gitignore
  2. .gitmodules
  3. LICENSE
  4. NOTICE
  5. README.md
  6. archetypes/
  7. config.toml
  8. extract_celix_docs.sh
  9. layouts/
  10. publish.sh
  11. source/
  12. static/
README.md

Apache Celix website

This is the source code for the website of Apache Celix, hosted at:

https://celix.apache.org/

Repository structure

This repository uses 2 branches for serving the website.

  • The master branch, which contains all the sources for the website.
  • The asf-site branch, which contains the generated website being used for the Celix website.

When contributing patches, apply them to the master branch. Jenkins will then regenerate the website and commit the changes to the asf-site branch.

Content Management System

The Celix website uses Hugo as static website generator. See Hugo for more info and for details how to install Hugo.

Generate the website

Copy documentation dir from celix repo

  • Run git submodule init and git submodule update to retrieve the Celix sources.
  • Run ./extract_celix_docs.sh to copy the markdown files from the Celix main repository to the site repository.

Create doxygen documentation

TODO

Generate the static website

To generate the static website, execute hugo to generate and serve the website on localhost:1313.

During development, it may be useful to run an incremental build. For this to work, execute hugo server -D to continuously generate and serve the website on localhost:1313.

Publish the website

Jenkins is used for generating the website and committing the generated site to the asf-site branch.