-
Couldn't load subscription status.
- Fork 110
📘 Document static theme development #2309
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
base: main
Are you sure you want to change the base?
📘 Document static theme development #2309
Conversation
|
|
@stefanv ping Not sure what I did to get all the --config commits appearing in this PR... but it only shows the single |
15054c9 to
6b72c8f
Compare
docs/developer.md
Outdated
|
|
||
| The [`myst-theme` README](https://github.com/jupyter-book/myst-theme/) provides a more detailed overview of the components of that package. | ||
|
|
||
| A theme may be deployed locally for development as a dynamic theme server, _or_ a site may be statically built against a local theme. Development procedures will be different depending on which deployment scenario you are targeting. |
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.
| A theme may be deployed locally for development as a dynamic theme server, _or_ a site may be statically built against a local theme. Development procedures will be different depending on which deployment scenario you are targeting. | |
| For local development, there are two ways to deploy the theme (AKA the website): | |
| as a server, or as a static build. Development procedures are slightly different, depending on which approach you take. |
I hope my rephrasing is accurate 🤔
Here, we could also add a short sentence as to why you might use which approach. E.g., something like: "The static build approach is typically used when..." where it might be "you need a React debug build" or "you want to emulate a GitHub Pages deploy" or ... ?
I just re-read the whole thing, and realized that matters are further complicated, because additionally you can build the theme into a JS package, or access the theme locally. It feels like, in this PR, we may be conflating the two axes: static/non-static build, pre-built or non-pre-built theme server.
…awthorne/mystmd into document-static-theme-development
Add material to the Developer Guide detailing how to build a static site against a local theme, and how to connect a step debugger to the node process.