168492376
/
qskinny
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update instructions

This commit is contained in:
Peter Hartmann 2024-11-25 17:09:59 +01:00
parent e16e254b48
commit e5b371ba3f
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/generate-website.md
View File

@ -30,6 +30,33 @@ doxygen
``` ```
This will generate the documentation into the `api` folder. This will generate the documentation into the `api` folder.
### Generating specific header and footer files for doxygen
*This needs to be done only when the doxygen version changes.*
```
cd ~/dev/qskinny/doc
doxygen -w html api/header.html api/footer.html
```
Now open `api/header.html` and copy the code block starting with
the comment `<!-- QSkinny WASM code -->` into the new header file.
*Also*, change the `<body>` tag to load the WASM code at
startup:
```
<body onLoad="docSampleInit()">
```
### Using a different stylesheet for doxygen
```
git clone git clone git@github.com:jothepro/doxygen-awesome-css.git
cd doxygen-awesome-css
git checkout v2.3.4
cp doxygen-awesome.css ~/dev/qskinny/doc/
```
### Testing and building the website locally ### Testing and building the website locally
First copy the generated files from above to the website repo: First copy the generated files from above to the website repo:
@ -62,7 +89,7 @@ new version of the homepage:
cp -r _site/* ~/dev/qskinny.github.io/ cp -r _site/* ~/dev/qskinny.github.io/
cd ~/dev/qskinny.github.io/ cd ~/dev/qskinny.github.io/
git commit -a -m "new version" # you might want to add new files git commit -a -m "new version" # you might want to add new files
gith push git push
``` ```
That's it, the new website is now published at https://qskinny.github.io/ . That's it, the new website is now published at https://qskinny.github.io/ .