The pages on this website are written in [markdown syntax] 1 and stored in our GIT repo at [src/site] 2
A subproject contained within the repo is used to generate the website from the Markdown text files and the resources stored in the content directory.
This Java solution is meant as an interim solution as we do not want to reinvent the wheel. Instead we are likely switching to Sphinx.
This website development page is divided into:
git clone https://github.com/tdf/odftoolkit
Install Gradle build system, see https://gradle.org/install/
Build the project:
cd odftoolkit/src/site/java
./build-html.sh
The src/site/site/content/odftoolkit directory contains web content - markdown, html, javascript, css, images and other files. Resources such as images, CSS files and ZIP files are copied as is to the web site during the build.
Using your favorite editors edit the site content.
Run this to generate the website into GitHub Pages directory <ODFTOOLKIT_ROOT>/docs
cd odftoolkit/src/site/java
./build-html.sh
Use your GitHub Pages on your GitHub fork using your Git branch and /docs as root! Use a broken link checker (e.g. https://www.drlinkcheck.com/) testing on your GitHub HTML deployment!
JavaDoc is generated as part of by calling from the root of the project the command:
mvn install
Run copy-javadoc.sh to build & copy the created API directories into the <ODFTOOLKIT_ROOT>/docs/api directory and remove any prior files within.
(cd src/site && ./copy-javadoc.sh)
Do the appropriate combination of git status, git add, and git commits.
For further information see the GitHub help on creating a pull request from a fork page.