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

Static site with interactive examples #61

Closed
5 of 6 tasks
keynmol opened this issue Sep 1, 2020 · 0 comments · Fixed by #63
Closed
5 of 6 tasks

Static site with interactive examples #61

keynmol opened this issue Sep 1, 2020 · 0 comments · Fixed by #63

Comments

@keynmol
Copy link
Sponsor Contributor

keynmol commented Sep 1, 2020

Premise: it would be great to have a static website with documentation published for Laminar.

To make this work the following things need to happen:

  • mdoc's :js modifier should be able to support SJS 1. PR on mdoc is halfway there, I've started completing it

    mdoc PR has been merged: Support Scala.js 1.x scalameta/mdoc#381

  • Laminar's build needs to be modularised to enable mdoc and Docusaurus plugin (work started here), the site generation works with locally published custom version of mdoc (see screenshot below)

  • CI pipeline needs to be adjusted to basically push entire contents of website/build (after sbt 'docs/docusaurusCreateSite') to gh-pages branch

  • optional custom color scheme and logo need to be chosen for Laminar site

  • Github Pages needs to be enabled and point at gh-pages branch of this repo

  • optional a custom domain needs to be configured to point at github pages.

After that it's all about populating the docs with lots of interactive examples.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants