Convert docs site to Jaspr

[spydon]

Problem to solve

It would be great to have our docs site in Jaspr to have even more of our code-base in Dart (and avoid weird package update problems from other ecosystems etc).

Jaspr is a free and open source framework for building websites in Dart. Create fast and dynamic web experiences with ease in a familiar language and ecosystem.

Proposal

We would need the following from Jaspr:

1. Docs written in markdown
2. Flutter examples embedded on the page
3. Mermaid diagram rendering
4. Syntax highlighting for code

According to @schultek 1, 2 and 4 already exists and 3 should be possible to create.

More information

• Currently we are using Sphinx
• The root of our docs live here: https://github.com/flame-engine/flame/tree/main/doc
• The docs are built and published from this repository: https://github.com/flame-engine/flame-docs-site/

Other

• [ ] Are you interested in working on a PR for this?

[schultek]

Happy to support / review any PR for this.

[KAVYAPUTTU]

Hi, I’m interested in contributing to this issue. I’m new to Jaspr but I’d love to start with migrating the docs, and then try adding Mermaid support. Could you please assign this to me?

[spydon]

Hi, I’m interested in contributing to this issue. I’m new to Jaspr but I’d love to start with migrating the docs, and then try adding Mermaid support. Could you please assign this to me?

Hi, we would preferably have someone that is used to Jaspr (or have proven to be very proficient in Dart) to take on this. If you want to start with adding mermaid support to Jaspr I think that is a better place to start.

[KAVYAPUTTU]

Understood, thanks for clarifying. I’m still new to Jaspr but I’d love to try implementing Mermaid support for it. I’ll start experimenting with integrating Mermaid.js and share my progress here, so I can get feedback as I go.

[spydon]

Understood, thanks for clarifying. I’m still new to Jaspr but I’d love to try implementing Mermaid support for it. I’ll start experimenting with integrating Mermaid.js and share my progress here, so I can get feedback as I go.

For mermaid support it would be better to handle that on a ticket on the Jaspr repository, don't you agree @schultek?

[schultek]

I don't want to add mermaid support to Jaspr (jaspr_content) itself. I think it would be cool to make this as a third party package, so I don't have to maintain it.

[KAVYAPUTTU]

Hi @spydon, @schultek,

Thanks for clarifying! I’ll start by creating a separate third-party Jaspr package for Mermaid support, as suggested. I’ll share my progress here and open a draft PR once I have a working demo.

[KAVYAPUTTU]

Hi, I started looking into this but I realize it’s more advanced than I expected.
I’ll leave it open so someone with more experience can take it.
Thanks for the guidance so far!

[dazemc]

This sounds interesting

[spydon]

This sounds interesting

Interesting as in that you want to work on it?

[dazemc]

Interesting as in that you want to work on it?

Trying to but cloudflare is saying otherwise right now

[dazemc]

Okay I started with a working mermaid implementation,

https://github.com/dazemc/jaspr_content_mermaid