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.

Sign up for GitHub

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

Jump to bottom

Add Markdown Support to docs.openedx.org #801

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add Markdown Support to docs.openedx.org #801

wants to merge 2 commits into from

Conversation

feanil
Copy link
Contributor

@feanil feanil commented Jan 22, 2025 •
edited
Loading

  • feat: Add support for markdown docs.
  • chore: Run make upgrade

Source
image

Render
image

@feanil
Copy link
Contributor Author

feanil commented Jan 22, 2025

Failures look like they're due to some upstream issues, I'll fix them in a separate PR.

@jswope00
Copy link
Contributor

@feanil I think if you merge the latest main into your branch that might fix the issue. This warning was observed already and fixed by @mariajgrimaldi in this PR: #778

feanil added 2 commits January 23, 2025 13:41
@feanil
feat: Add support for markdown docs.
d41f42a 
This will allow us to write documentation in either markdown or RST and
it can cross link and the documenter can use whichever they want.

This uses the MyST parser which documents how to write common sphinxs
concepts in markdown: https://myst-parser.readthedocs.io/en/latest/index.html
@feanil
chore: Run make upgrade
2fb3c1c
@feanil feanil force-pushed the feanil/add_markdown_support branch from 824f23e to 2fb3c1c Compare January 23, 2025 18:42
@feanil feanil marked this pull request as ready for review January 23, 2025 20:13
@feanil
Copy link
Contributor Author

feanil commented Jan 23, 2025 •
edited
Loading

Yep, that fixed it, if we land this, we can write markdown or RST in this repo.

@feanil feanil requested a review from a team January 24, 2025 14:33
@sarina
Copy link
Contributor

sarina commented Jan 29, 2025

Could you add a Markdown file as well so we can see this works? Maybe a Documentors How-To on writing MD files and how to include them?

@feanil feanil changed the title feanil/add markdown support Add Markdown Support Jan 31, 2025
@feanil feanil changed the title Add Markdown Support Add Markdown Support to docs.openedx.org Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@feanil @jswope00 @sarina