To build the website locally it should be sufficient to first clone this repo, then perform the following commands
sudo apt install -y biber latexmk texlive-bibtex-extra texlive-lang-japanese texlive-latex-extra texlive-latex-recommended
(Note pre-existing linux package installations may be checked using *sudo apt list --installed* which takes multiple arguments.)
mkdir public
bash buildwebsite-local.sh
then open public/index.html in your preferred browser. The homepage for this branch is available at https://excalibur-neptune.github.io/Developers-Website/main/main.html
If you want to generate just the pdf version of the website then you perform the following command
bash buildwebsite-local.sh PDF
and the PDF appears as ./public/main.pdf
If you want to generate just the HTML and PDF of some tex, and not the whole website, then you perform the following command (where proxyapps/proxyapps is replaced with the relative path to the tex file you want to convert to PDF and HTML)
bash singlepage.sh '\input{proxyapps/proxyapps}'
When adding a new chapter or section to the latex documentation the following command should be used instead of \section and \chapter
\newsection{}{}
and
\newchapter{}{}
where the first argument is the section/chapter title and the second argument is the label for that section/chapter. If you do not want the new section or chapter to start on a new webpage, then you use the following
\newsectionnobreak{}{}
and
\newchapternobreak{}{}
To build the website, follow the instructions for the native linux distro above. N.B: Ubuntu 22.04 is now available on the MS Store, no need to manually upgrade an earlier version.
To view the website from a browser in windows, go to
file://wsl%24/Ubuntu-22.04[path_to_website_repo]/public/index.html
Note that the instructions for 22.04 won't work for 20.04, as the texlive-latex-recommended package contains an older version of lwarp.
While it may be possible to upgrade lwarp, there are issues with using tlmgr that make this non-trivial.
You can upgrade from Ubuntu 20.04 to 22.04 within the terminal using the following commands
sudo apt update
sudo apt upgrade
sudo do-release-upgrade
To check you have upgrade to 22.04 after you have rebooted WSL use the following command
lsb_release -a
If you need to install WSL to your Windows system then follow this guide https://docs.microsoft.com/en-us/windows/wsl/install