epicweb-dev / epicweb-dev/epic-stack-docs

Initial Implementation

Offen
#1 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
15
Forks
2
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Just a few thoughts:

1. I would like the docs to use markdown and be hosted publicly on GitHub
2. I would like the site and source for the docs to be in this repo
3. I would like an update to the docs to not require a redeploy of the site (so runtime markdown compilation via mdx-bundler maybe + caching will be necessary).

I'm really thinking the architecture can be similar to [my site](https://github.com/kentcdodds/kentcdodds.com) which is similar to the Epic Stack in many ways. [This file](https://github.com/kentcdodds/kentcdodds.com/blob/main/app/utils/compile-mdx.server.ts) is probably most helpful for compiling mdx on the fly. A simpler and similar implementation that you may reference is [the speed-metal-stack](https://github.com/Girish21/speed-metal-stack) which is based on my personal site.

Personally, I'd probably start with the Epic Stack and remove stuff we don't want. I think keeping the user accounts could actually be useful for the admin interface with the cache etc.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.