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

Editor feature documentation #798

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

jossmac
Copy link
Member

@jossmac jossmac commented Dec 1, 2023

@keystar/ui

Improve prose styles:

  • Style kbd elements
  • Basic table styles

@keystatic/core

Document editor features, within footer actions:

  • "Markdown support" button opens a dialog containing information about formatting and syntax
  • "Paste, drop, or click to add images" button invokes the file browser

@jossmac jossmac requested a review from emmatown as a code owner December 1, 2023 04:02
Copy link

changeset-bot bot commented Dec 1, 2023

🦋 Changeset detected

Latest commit: fc4376b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 14 packages
Name Type
@keystar/ui Patch
@keystatic/core Patch
@keystar/docs Patch
@example/next-app Patch
@example/next-pages Patch
keystatic-docs Patch
@example/astro-content Patch
@example/astro Patch
@example/localization Patch
@example/next-block-builder Patch
@keystatic/remix-test-app Patch
@keystatic/templates-astro Patch
@keystatic/templates-nextjs Patch
@keystatic/templates-remix Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Dec 1, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
keystatic-site ✅ Ready (Inspect) Visit Preview Apr 9, 2024 10:23pm
3 Ignored Deployments
Name Status Preview Updated (UTC)
keystar-ui ⬜️ Ignored (Inspect) Visit Preview Apr 9, 2024 10:23pm
keystatic ⬜️ Ignored (Inspect) Visit Preview Apr 9, 2024 10:23pm
keystatic-next-blocks-builder ⬜️ Ignored (Inspect) Visit Preview Apr 9, 2024 10:23pm

@jossmac jossmac enabled auto-merge (squash) December 1, 2023 04:02
Comment on lines +164 to +179
<h3>Lists</h3>
<p>
You can make an unordered (bulleted) list by preceding one or more
lines of text with <kbd>-</kbd>, or <kbd>*</kbd>.
</p>
<pre>
<code>{`- Red\n- Green\n- Blue`}</code>
</pre>

<p>
Create an ordered (numbered) list by preceding each line with a
number.
</p>
<pre>
<code>{`1. Red\n1. Green\n1. Blue`}</code>
</pre>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I'd describe it like this, seems a bit weird since you'd just add e.g. the 1. on the first time and then press enter for more, you wouldn't precede every line with a number yourself

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, needs to be reconsidered.

@jossmac jossmac disabled auto-merge December 1, 2023 04:18
@jossmac jossmac marked this pull request as draft December 1, 2023 04:18
Comment on lines +69 to +72
<p>
Markdown is a way to style text; it is intended to be as
easy-to-read and easy-to-write as is feasible.
</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels weird to say this when you're not reading markdown, there are just some markdown shortcuts

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah agreed, this is all pretty green. Switching to draft for now; we can workshop the content whenever, the concept and UI are in place.

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

Successfully merging this pull request may close these issues.

2 participants