-
-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
nixpkgs-manual-mmdoc, nixos-manual-mmdoc: init #108063
base: master
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of the edits here should be removed and it should be rebased on top of #108147
This comment has been minimized.
This comment has been minimized.
I've extracted the work into its own project now https://github.com/ryantm/mmdoc |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-01-04-documentation-team-meeting-notes-102/37754/1 |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-01-25-documentation-team-meeting-notes-106/38792/1 |
9f62601
to
d537f79
Compare
This is being discussed a bit in the docs Matrix room |
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/help-wanted-planning-for-summer-of-nix-2025/47556/2 |
This is a prototype Markdown manual renderer that has as few dependencies as possible. We might wish to have something like this because it would limit the build closure required for building the manuals, which is most important for NixOS.
The only dependencies are:
It uses assets from
Another benefit of this minimal approach is the manual can be rendered very quickly. cmark claims it can render War and Peace in 100 ms.
Try the Live demo!
Try it yourself
http://localhost:8000/
in your web browser