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

Switch to MyST and MyST-{NB} with book-theme #581

Merged
merged 3 commits into from
Apr 25, 2021
Merged

Switch to MyST and MyST-{NB} with book-theme #581

merged 3 commits into from
Apr 25, 2021

Conversation

krassowski
Copy link
Member

@krassowski krassowski commented Apr 24, 2021

References

Fixes #540. Also documents what is needed from kernels for new language severs to work with notebooks as discussed in https://github.com/krassowski/jupyterlab-lsp/issues/578#issuecomment-825127252 which closes #384.

Test it online: https://jupyterlab-lsp--581.org.readthedocs.build/en/581/

Code changes

  • Markdown magics are now used only for paragraphs which do not include headings

User-facing changes

  • Nicer docs
  • A temporary logo in docs

General look and feel

Screenshot from 2021-04-24 22-12-06

Previously problematic spots as documented in #540 - now all render fine

Screenshot from 2021-04-24 22-14-43
Screenshot from 2021-04-24 22-14-22
Screenshot from 2021-04-24 22-14-06
Screenshot from 2021-04-24 22-13-50
Screenshot from 2021-04-24 22-13-19

Backwards-incompatible changes

None; the URL to Language Servers page linked in GUI stays the same.

Chores

  • linted
  • tested
  • documented
  • changelog entry

@krassowski krassowski requested a review from bollwyvl April 24, 2021 22:57
@bollwyvl
Copy link
Collaborator

The preview looks quite nice.

We have a lot of wide code/tables/images.... it may be worth adding a little custom css. This can be coupled with some rules to make narrative p be the traditional ~45em, but takes a little fiddling to get right... i've come up with this pattern:

@media (min-width: 1200px) {
  .container,
  .container-xl {
    max-width: 100%;
  }
}

p, .admonition {
  max-width: 48em;
}

Screenshot from 2021-04-24 22-24-21

@krassowski
Copy link
Member Author

Right. Fortunately, I managed to do so with cell tags, without changing the layout:

Before:

Screenshot from 2021-04-25 12-21-12

After:

Screenshot from 2021-04-25 12-32-54

@krassowski krassowski merged commit 8565b00 into master Apr 25, 2021
@krassowski krassowski deleted the myst branch April 25, 2021 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation theme and markdown parser Language server not starting for custom language type
2 participants