-
Notifications
You must be signed in to change notification settings - Fork 217
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
Publish guide as mdbook #664
Conversation
These are some general notes about There are a few options to get syntax highlighting to work for
|
I like this, but I wonder if hosting it at |
I'm on board with adding the documentation in mdbook form for this repository; I tried following the instructions to do so but As a note, this will be a short-term-ish solution as we have some plans to put together a nicely-designed documentation site from the documentation which includes more information on Halogen -- kind of like the React docs site. |
@milesfrain I've added a deploy key and I believe everything's good to go. When the build completes I'll merge to master and we can take it from there wrt ensuring it's working properly and any design improvements. |
The generated site is available now: Thanks @milesfrain! I've also updated links -- some still point at the docs folder, but the main links point to the docs site. |
This commits add the ability to deploy the documentation as an mdbook until Halogen has a full documentation website.
The mdbook viewer is a bit nicer than clicking through a tree of markdown files on github. Plus it gives you a single page / print view, which makes finding stuff a lot easier.
Here's an instance hosted on my fork:
https://milesfrain.github.io/purescript-halogen/
But we'll want to host it on this repo's gh-pages site, e.g.:
https://purescript-halogen.github.io/purescript-halogen/
We might also be able to redirect from halogen.purescript.org
To transfer, you'll just need to create a new encrypted deploy key for this repo, and overwrite
github_deploy_key.enc
with it.Concise instructions for that process can be found here:
https://gist.github.com/qoomon/c57b0dc866221d91704ffef25d41adcf