nnelgxorz / qwik-city-content Goto Github PK

Currently, we use Serde to deserialize yaml and to serialize JSON.

Because we perform manipulations on the Page struct, it may be an unnecessary allocation. Further, if we replace the yaml deserialization with a custom option tailored to our use case, Serde could be completely dropped as dependency.

This would reduce the size of our binaries and likely result in performance boosts.

Investigate if there is way to override the type for RouteParams with the generated type, removing the need to import and cast route params.

No more of this, for example:

import {RouteParams} from './generated'

export default component$(() => {
  const params = useLocation().params as RouteParams;
 //...
})

Currently we use serde to deserialze yaml. It deserializes into a BTreeMap which is not an ideal data structure. Serde_yaml also doesn't support zero copy deserialization, so we are allocating anytime we deserialize.

Ideally, we can parse yaml into a flat data structure and only reference the &str source, without copying/allocating anything.

This is something that must be done for every content page, so it would be a big win for performance.

Once MVP features are stable, begin performance profiling with an eye toward:

• Getting data into CPU caches
• Removing allocations
• Improving algorithms

Implement for feature parity with current Qwik City

https://docs.rs/pulldown-cmark/latest/pulldown_cmark/struct.Options.html

Allow users to mark content as a draft using draft: true to remove a piece of content from the output.

Implement for feature parity with current Qwik City.

https://github.com/trishume/syntect

Using the Merge helper type is a cool trick, but Typescript starts to choke on larger collections.

Ideally, we can generate types for each collection manually to prevent any bottlenecks on larger content collections.

Currently our error handling is very sloppy. Ideally, we would have our own Error enum and the ability to early return using ? from functions instead of checking for errors and console logging them.

Currently, for simplicity, we just support markdown and output a single html string. This will not work for mdx that imports Qwik components.

Investigate options for the optimal pre-processing.

Implement for feature parity with current Qwik City.

https://github.com/rehypejs/rehype-autolink-headings

https://github.com/BuilderIO/qwik/blob/main/.github/workflows/ci.yml#L118-L277

https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/core