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

Support for Markdown files #683

Open
tdudgeon opened this issue Aug 21, 2022 · 3 comments
Open

Support for Markdown files #683

tdudgeon opened this issue Aug 21, 2022 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@tdudgeon
Copy link
Contributor

We need to support the ability for users to document their work in projects.
A simple way of handling Markdown files, and special treatment of README.md in a way similar to how GitHub does this would go a long way towards this.

Need to be able to:

  • display formatted Markdown files in a viewer
  • if a README.md file is present then display it's contents as part of the directory listing
  • allow to edit Markdown files
  • allow to incorporate links to other files in the project (and external URLs) into the Markdown content
@tdudgeon tdudgeon added the enhancement New feature or request label Aug 21, 2022
@OliverDudgeon
Copy link
Contributor

Display of markdown should be quite easy since we already display mdx files
Editing is more difficult but is possible via Jupyter currently

@tdudgeon
Copy link
Contributor Author

Yes, editing can be done in Jupyter for now, but I bet there's a library that we can use that allows this.

@OliverDudgeon
Copy link
Contributor

Yes, the engine behind VSCode can be deployed which supports a lot of stuff including markdown.

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

No branches or pull requests

2 participants