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

Use mdbook for site #31

Closed
roberth opened this issue May 30, 2022 · 6 comments
Closed

Use mdbook for site #31

roberth opened this issue May 30, 2022 · 6 comments
Labels
good first issue Good for newcomers

Comments

@roberth
Copy link
Member

roberth commented May 30, 2022

Should be feasible as the options generation is already using pandoc instead of docbook's own tooling. Wouldn't mind doing more ugly stuff either, if necessary.

@roberth roberth added the good first issue Good for newcomers label May 30, 2022
@srid
Copy link
Contributor

srid commented May 30, 2022

I'd shamelessly plug Emanote 😁 but mdBook is a fine choice as well.

@roberth
Copy link
Member Author

roberth commented May 30, 2022

I thought of mdBook because it appears to have some momentum. I've been using mostly antora (advanced asciidoc) in recent times.

I'm inclined to go with something simple. I like mdBook's search capability and minimalist look. Not having search is probably a dealbreaker because I want to categorize the options by repo, yet still have a search capability for all of them together.

@zimbatm
Copy link
Contributor

zimbatm commented May 31, 2022

@roberth feel free to steal https://github.com/numtide/devshell/blob/master/modules/modules-docs.nix . It should work with any module system. Just import it and then access config.modules-docs.markdown to get the modules documented as markdown.

Here you can see how it's plugged with the rest of mdbook: https://github.com/numtide/devshell/blob/fc7a3e3adde9bbcab68af6d1e3c6eb738e296a92/default.nix#L34-L43

@roberth
Copy link
Member Author

roberth commented May 31, 2022

@zimbatm Thanks!

For now the docs are in docbook, which is kind of the standard for the module system. I'd like to migrate all module system applications to either markdown or something flexible and I figured my current solution might provide some of the ingredients for that. Here's my secret plan NixOS/nixpkgs#175586.

@zimbatm
Copy link
Contributor

zimbatm commented May 31, 2022

😅 How to succeed in two easy steps. Step 1) Submit a refactor PR to nixpkgs. Step 2) Success!

@roberth
Copy link
Member Author

roberth commented Nov 11, 2022

Done in #68

@roberth roberth closed this as completed Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants