freeCodeCamp / freeCodeCamp/devdocs

markdown export

Open
#2,645 1 comment 0 reactions 0 assignees View on GitHub
feature
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
13

Description

Couldn't sort out how to add something to Trello, adding here.

# Feature request

Markdown export to existing docs (where possible).

## Summary

The idea would be to show a markdown version of a page by using the ".md" extension to url's. This would be an alternative to the HTML view.

Devdocs already has simplified views of documentation, adding an option to view documentation or export documentation in markdown view would add some additional utility. Rather than depending on a conversion from html to markdown, especially in case where a document was originally in markdown.

This would also enable a potential AI integration, where markdown is preferred.

## Examples

I came across another service having the feature: https://www.mintlify.com/docs/ai/markdown-export

Contributor guide

Open the contributing guide

Research direction

The issue does not name any files, tests, or code entry points. Start by tracing how existing documentation pages are served through their HTML URLs, then determine how an .md URL could expose original Markdown where available. Done should include a defined Markdown export behavior for existing documentation and coverage for the relevant page types.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.