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

docs: generate mdbook docs #5

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: generate mdbook docs #5

wants to merge 2 commits into from

Conversation

hugosenari
Copy link
Contributor

@hugosenari hugosenari commented Nov 21, 2022 •
edited
Loading

Dynamic options docs

To build documentation as HTML

cd gh-pages
mdbook build

Configuration for github-pages not included

Good:

  • Keep markdown and nix file in sync by running nix develop build

Bad:

  • There is a workaround, for infinity recursion
  • Add dependencies (devshell and devshell-files)

Other Options

This was referenced Nov 22, 2022
Open
Open
@lucasew lucasew mentioned this pull request Nov 28, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@hugosenari