[FORMAT]: Markdown not formatted well

[mickahell]

Summary

• Jupyter markdown list seems to not be formatted well :

  "source": [
  "First we introduce glossary:\n",
  "- `Trial` is a tracking class which wraps a single execution of your quantum experiment\n",
  "- `Storage` is a class responsible for storing trial data\n",
  "\n",
  "We will show simple example of measuring expectation value of an observable and how to track all information about this experiment.\n",
  ]

  see : https://icekhan13.github.io/purplecaffeine/guides/01_tracking_quantum_experiments.html

• Jupyter markdown code link seems to not be formatted well :

  "source": [
  "### Automatically\n",
  "\n",
  "A full [`docker-compose.yml`](https://github.com/IceKhan13/purplecaffeine/blob/main/docker-compose.yml) is provided. It's containing postgres and the api."
  ]

  see : https://icekhan13.github.io/purplecaffeine/guides/04_setup_api.html

• Seems to have problem with coloration of bash bloc, but that's maybe a problem with sphinx

see : https://icekhan13.github.io/purplecaffeine/guides/04_setup_api.html

---

See PR https://github.com/IceKhan13/purplecaffeine/pull/77 for source.

[Eric-Arellano]

I think these might all be problems with Sphinx, rather than the theme. Sphinx is what decides the HTML, such as what is a list and what is not. The theme only controls how those HTML elements are styled via CSS.

For example, with the list, see https://qiskit.github.io/qiskit_sphinx_theme/sphinx_guide/how_to_create_lists.html for examples of lists.

Idk what's going on with that link. But try out the theme alabaster to see if it makes a difference. Seems like some problem with nbconvert, rather than the theme.

What's the problem with the Bash block?

[mickahell]

Oh ok indeed. I'll check that. You close the issue if you thing it's not related :)

With bash, the coloration :

[Eric-Arellano]

Got it. The code coloring is entirely from Pygments and not from our theme. You could try out different Pygments styles. You can configure it like this:

https://github.com/Qiskit/qiskit_sphinx_theme/blob/021d418f0fea2c6a3b6738b37f20b7c91028be0f/example_docs/docs/conf.py#L73-L74