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

Initial PR showcasing how to create docs using the Markdown to WordPress workflow #46

Open
wants to merge 8 commits into
base: trunk
Choose a base branch
from

Conversation

flexseth
Copy link

@flexseth flexseth commented Apr 15, 2024

Here are a few starting docs, and a sample video for how I created them.

The Jetpack plugin with Markdown module enabled allowed me to import Markdown into WordPress.

I'm not sure if it was WP-CLI auto-formatting the Markdown files, or the editor understanding the post import that made this work so seamlessly.

When I created posts manually by copy/pasting the Markdown into a MD block in Jetpack, it included some unnecessary content wrappers.

Might test on another PR.

Markdown.to.WordPress.mov

Let me know what you think about the flow! I've got a lot more content incoming this week.

@adamziel
Copy link
Owner

As discussed in Slack – let's make sure all the documents in this PR are block markup, not HTML or Markdown. Also, I see some "TODO" comments, checklists, and incomplete lists. Please remove them as they will be confusing for someone reading these pages to learn from them.

@flexseth
Copy link
Author

flexseth commented Apr 15, 2024

Filling in docs

How about including links to more information

More information link

add guidance:

See a section with a "More info" link? Help us improve the documentation!

Block markup conversion

When the content is imported via the wp-cli workflow mentioned above, it will be using the Classic Editor - if you click Convert to Blocks it will swap all blocks to block markup

@flexseth
Copy link
Author

flexseth commented Apr 17, 2024

"TODO" comments, checklists, and incomplete lists. Please remove them as they will be confusing for someone reading these pages to learn from them.

Ok, I'll have to go back and update the files. There's been quite a bit of info filled in

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