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

feat(v2): markdown pages #2947

Closed
wants to merge 5 commits into from
Closed

feat(v2): markdown pages #2947

wants to merge 5 commits into from

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Jun 16, 2020

Motivation

#2882

We should be able to create pages by dropping a .md / .mdx file directly into the /pages folder.

Test Plan

Deploy preview and tests

2 pages created for now:

  • /hey/ => index with a link
  • /hey/test => contains a copy of the "markdown features" doc

TODO

  • define frontmatter options?
  • define additional md logic, like doc linking using paths?
  • define a md page's CSS layout (already quite nice imho)
  • add required comp to theme-bootstrap

@slorber slorber marked this pull request as draft June 16, 2020 16:50
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 16, 2020
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Jun 16, 2020

Deploy preview for docusaurus-2 ready!

Built with commit a556e58

https://deploy-preview-2947--docusaurus-2.netlify.app

@slorber slorber linked an issue Jun 16, 2020 that may be closed by this pull request
@slorber
Copy link
Collaborator Author

slorber commented Jun 16, 2020

Hey @yangshun @lex111 what do you think of this draft?

About the frontmatter, what options do you think we should use?

How do you see linking working? Should we just use regular pathnames or should we allow relative file paths as well (like it is done for docs)? And if so, what's the story for linking from a md page to a md doc?

@fanny I guess I should also add the MDXPage component to the bootstrap theme? How do you usually test this theme? Is there a way to deploy automatically a starter site to ensure we don't break it when modifying classic theme?

@fanny
Copy link
Contributor

fanny commented Jun 22, 2020

@fanny I guess I should also add the MDXPage component to the bootstrap theme? How do you usually test this theme? Is there a way to deploy automatically a starter site to ensure we don't break it when modifying classic theme?

Hey, I use the same manner that we use to test the classic theme, loading the corresponding plugin using a template, in my case, the bootstrap. But in few days, I'll try to setup a structure for automated tests.

@slorber slorber mentioned this pull request Jun 23, 2020
@slorber
Copy link
Collaborator Author

slorber commented Jul 29, 2020

Superseeded by #3158

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

Successfully merging this pull request may close these issues.

Markdown support for pages
4 participants