Hi,
I've recently done a bit of a re-write on the docs
The content is still in markdown
but what I've also included is some python scripts that use mkdocs to render the docs into a static web page
Github has a feature called github pages where if you publish static html content to a branch called "gh-pages" in the repo, it's served out as a web page for the project
I'm not sure if you want to use mkdocs for this sort of thing, the python scripts for the setup are just a copy / paste from something I've used before
the theme is bootswatch / bootstrap / cyborg although there are also other colour schemes as well
there's a couple of custom theme files in there to add in Edit and Doxygen buttons to the title for the bootswatch themes
There's also some doxygen files in there as well for generating an api reference as part of the site
However at the moment it's only picking up on the QtSharp.CLI apps and libs, not the generated QtSharp libs
I think the doxyfile needs a bit of tweaking to avoid picking up too much
The details on how to run the scripts should be under Docs\MkDocs\Readme.md
"build.py build_doxygen" - generate Doxygen content, best to run after changing the menu content / page list to update the header for it.
"build.py serve" - preview the site via a local link of http://127.0.0.1:8000 which auto refreshes on content change.
"build.py publish" - generate the site and auto push it to the gh-pages branch
Hi, I've recently done a bit of a re-write on the docs
The content is still in markdown but what I've also included is some python scripts that use mkdocs to render the docs into a static web page Github has a feature called github pages where if you publish static html content to a branch called "gh-pages" in the repo, it's served out as a web page for the project
In theory if the branch existed it would appear under the link of - http://ddobrev.github.io/QtSharp I've put a preview of what it would look like on my fork here - http://grbd.github.io/QtSharp
I'm not sure if you want to use mkdocs for this sort of thing, the python scripts for the setup are just a copy / paste from something I've used before the theme is bootswatch / bootstrap / cyborg although there are also other colour schemes as well there's a couple of custom theme files in there to add in Edit and Doxygen buttons to the title for the bootswatch themes
There's also some doxygen files in there as well for generating an api reference as part of the site However at the moment it's only picking up on the QtSharp.CLI apps and libs, not the generated QtSharp libs I think the doxyfile needs a bit of tweaking to avoid picking up too much The details on how to run the scripts should be under Docs\MkDocs\Readme.md
"build.py build_doxygen" - generate Doxygen content, best to run after changing the menu content / page list to update the header for it. "build.py serve" - preview the site via a local link of http://127.0.0.1:8000 which auto refreshes on content change. "build.py publish" - generate the site and auto push it to the gh-pages branch