search

IBM / dbb-zappbuild

zAppBuild is a generic build solution for building z/OS applications using Apache Groovy build scripts and IBM Dependency Based Build (DBB) APIs.
Apache License 2.0
40 stars 140 forks source link

Mkdocs material #313

Closed ijmitch closed 11 months ago

ijmitch commented 1 year ago

Goodness... I should have described the intent here!

This turns the Markdown files into a Github Pages site generated using Mkdocs so we get:

image

rather than the default rendering of the source.

ijmitch commented 1 year ago

BTW, this is pretty much the same as I did for https://ibm.github.io/tnz/

dennis-behm commented 1 year ago

@ijmitch I have modified the target branch of the PR to be develop instead of main, which is now leading to some merge conflicts. Can you please take care of them?

ijmitch commented 1 year ago

I will have a go!

ijmitch commented 1 year ago

Fixed the merge conflicts but also the links from doc back into other types of source files in the repo.

ijmitch commented 1 year ago

In Settings for the repo, you need to update the 'Pages' setting to match...

image

Which should just mean setting the source to deploy from the gh-pages branch.

ijmitch commented 1 year ago

hmm... the fixed links which worked in my local environment are failing on https://ijmitch.github.io/dbb-zappbuild/ - work to do.

ijmitch commented 12 months ago

hmm... the fixed links which worked in my local environment are failing on https://ijmitch.github.io/dbb-zappbuild/ - work to do.

I needed to cherry-pick one more commit from the working branch into main in order for the links to work in the build.

Now basically all working on https://ijmitch.github.io/dbb-zappbuild/

ijmitch commented 11 months ago

Closing this.

Docusaurus might be a better option.