Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Evaluate SSG options #3

Open
ijmitch opened this issue Jan 5, 2023 · 2 comments
Open

Evaluate SSG options #3

ijmitch opened this issue Jan 5, 2023 · 2 comments
Assignees
@ijmitch

Comments

@ijmitch
Copy link
Contributor

ijmitch commented Jan 5, 2023

my current favourite is Mkdocs with the Material theme (https://squidfunk.github.io/mkdocs-material/) which I recently used successfully to convert doc for the https://github.com/IBM/tnz project from the wiki to a Github Pages site.

Just-the-Docs is another candidate which I've on https://kgb1001001.github.io/cloudadoptionpatterns/ too so know how to use that as well.

I think Mkdocs is more mature and easier/more versatile than Jekyl/Just-the-Docs. Indeed ReadtheDocs is now favouring Mkdocs over their original choice of Sphinx.
@ijmitch ijmitch self-assigned this Jan 5, 2023
@ijmitch
Copy link
Contributor Author

ijmitch commented Jan 18, 2023

During today's call Matt Hogstrom suggested using the Zowe project's approach to their docs as a model for this project.

As can be seen in zowe/docs-site#1739 they currently use Docusaurus as their SSG.

@ijmitch
Copy link
Contributor Author

ijmitch commented Jan 18, 2023

Here's a Youtube 'ELI5' on Docusaurus... https://youtu.be/_An9EsKPhp0

(Perhaps we should aim for an ELI5 video for Mainframe Modernization!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ijmitch ijmitch

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ijmitch