This page gives instructions on doing website development on your computer.
Source code generation has been tested successfully with Python 2.7.16
NOTE: The Apache CMS 3 bundled within the site directory depends on old libraries.
sudo apt-get install -y python2.7-elementtree sudo apt install python-pip python -m pip install "Markdown<2.6.0" python -m pip install "Pygments==2.2.0"
git clone https://github.com/tdf/odftoolkit cd odftoolkit/src/site
site/lib/path.pm are copied as is to the web site during the build.
src/site/site/templates directory contains the html skeletons used during the site build.
skeleton.html- our current html page template.
sidenav.mdtext- markdown of the side navigation panel.
src/site/site/lib directory contains two python modules that determine how content files are processed during the site build.
path.pm- maps file patterns like
.mdtextinto the view building routines. We can expand to cover other patterns.
view.pm- a set of python subroutines for converting content into web pages.
You can find the CMS build tools in the
src/site/cms/build/- perl scripts for building the site and markdown extensions.
src/site/cms/conversion-utilities/- scripts used by various projects for conversion including
src/site/cms/webgui/- the webgui behind the
Using your favorite editors edit the site content, templates.
build-site.sh script to build the markdown to HTML and copy all resources into the odftoolkit/docs directory.
Afterthe changes have been merged to the master branch, all changes will become visible at https://tdf.github.io/odftoolkit/docs/
JavaDoc is generated as part of the
mvn clean install command called from the root of the project.
copy-javadoc.sh script to build copy the created API directories into the odftoolkit/docs/api directory and remove any prior files within.
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.