microsoft / microsoft/pxt

Route *.md paths to page renderer

Open
#8,584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2.3k
Forks
641
Avg merge
12h 4m
Merged PRs (30d)
57

Description

Description

Requesting a page for an absolute *.md path will serve the actual text/markdown instead responding with 404 or the rendered page. Showing the markdown text for the resource seems confusing for the user.

As an example, submitting http://arcade.makecode.com/about.md will serve the raw markdown for the resource instead of something more friendly:

Request URL: https://pxt.azureedge.net/blob/d4012fb88abbbca0ce64a731d5afa9b4af5f706f//about.md

# About MakeCode Arcade

MakeCode Arcade is a code editor to build Retro Arcade games for the browser
and handheld consoles.

* [Try it now!](https://arcade.makecode.com)


* [Projects](/projects)
* [Documentation](/docs)
* [Hardware](/hardware)
* [Publishing games](/publishing-games)

Current behavior

md-routing

Suggested change options

  1. Respond with the 404 page instead.
  2. In the case of a resource ending with .md, route it to the path minus the extension and just render the referred doc page.

Version info

Chrome: Version 95.0.4638.69 (Official Build) (64-bit)
arcade version:  1.6.24
Microsoft MakeCode version:  7.2.25

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the behavior with the example /about.md URL, then trace the routing and page-renderer entry points that handle absolute paths ending in .md. Determine whether the intended result is a 404 or rendering the extensionless page, and verify that the chosen behavior replaces the raw markdown response.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.