Skip to content
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

Define content authoring format(s) #348

Closed
ALRubinger opened this issue Mar 17, 2023 · 1 comment
Closed

Define content authoring format(s) #348

ALRubinger opened this issue Mar 17, 2023 · 1 comment
Assignees

Comments

@ALRubinger
Copy link
Contributor

We've been standardizing around Markdown as an authoring format. This is great for content contributors: clear, well-documented, lightweight format for writing content.

It also lets us add "flavors" like specific extensions we can render on the page beyond standard Markdown, for instance if we want to do something like "embed a terminal command", like this example from expo.dev:

Image

We also potentially have more structured needs beyond what Markdown can provide. Consider also from expo.dev, this docs home:

Image

This is implemented as a straight-up React page.

This kind of intentional layout is likely more than we can get with Markdown alone; it gives more control to us to get precise about how we'd like things surfaced on the page.

So:

  • Is that greater control something we build into our Markdown support as a "flavor", leaving the content authoring format to a Markdown flavor we document?
  • Are those pages instead done in something like React or MDX?
  • If it does necessitate MDX/React, does that give us 2 potential authoring formats?
  • ...and based on those decisions, we've got to document in our docs contribution guide.

Let's get a decision on this for Phase 2, even if that decision is "we'll only support Markdown as-is for this Phase, and iterate on structured content like the example above for Phase 3."

@dayhaysoos
Copy link
Contributor

After talking to @bobbilee19 about this:

  • There will be two authoring formats: MDX and React (we can still process MDX files even if the format ends in .md

MDX will be used for the docs content, such as Intros, Tutorials, getting started pages or anything that pertains to the actual learning content.

React pages will be used for initial "home pages" of docs sections. For example, /docs will be a page done in React.

We don't want our initial pages to have the look and feel of a regular docs page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

3 participants