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

feat: initial structure of mdBook including existing content #8

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

mlegner
Copy link
Collaborator

@mlegner mlegner commented Jun 5, 2024

The content is taken from our existing documentation, with slight adaptations to better fit the book structure.

Currently, this is not built or deployed automatically. You can build and access it locally as follows:

cargo install mdbook
mdbook serve

In a follow-up PR I will add an automatic deployment as well as previews for PRs.

Closes #2

@mlegner mlegner requested a review from gdanezis June 5, 2024 08:38
Copy link
Contributor

@gdanezis gdanezis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing, tested it and it works and produces a static site!

@mlegner mlegner merged commit 9e96d01 into main Jun 5, 2024
5 checks passed
@mlegner mlegner deleted the ml/init-mdbook branch June 5, 2024 12:03
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.

Initialize mdBook with existing documentation
2 participants