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.

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

mdBook version of documentation #698

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

timClicks
Copy link

Include a version of ZDB's documentation in tree with a custom mdBook theme.

@eeeebbbbrrrr
Copy link
Collaborator

Thanks @timClicks! <3

What's the easiest way to look at this? Checkout your branch and just open index.html or what?

I'll also need to figure out how to get this on zombodb.com, which is not fun to update.

@eeeebbbbrrrr eeeebbbbrrrr changed the base branch from master to develop November 23, 2021 17:57
@timClicks
Copy link
Author

What's the easiest way to look at this? Checkout your branch and just open index.html or what?

Almost. The site is rendered at zombodb/docs/book.

It won't run as-is within GitHub pages though, which really wants the root of the site to be docs/.

@eeeebbbbrrrr
Copy link
Collaborator

I don't really understand what this means. :)

@aljazerzen
Copy link

I can assist here if you want.

I don't think that committing the docs into the git tree is the way to go, but instead build from mdbook at when building the website. How is the website built right now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants