Loading...
The README Editor
A project type for writing the documentation that goes with your work.
What it is
A README is a small project type of its own: a document rather than a program. Create one and the studio header reads README Editor and your list is Your READMEs.
Use it for the page that goes on a release — what the plugin does, how to install it, what each config option means — written with the same AI help as your code.
Why it is separate
Keeping documentation as its own project means it does not sit inside a plugin that you later rebuild, and it stays in your projects list where you can find it. Opening the README Editor from the tool navigation shows only these.
To get a README written from your actual code, open the plugin's own project in the Code Studio and ask its chat for one: that chat reads your files. Connecting the project in AI Chat does not work for this, because it sends only the file names, not what is in them (see Connecting a Chat to a Project).
Also in Code Studio (IDE)
- Next in Code Studio (IDE): Chrome Extension Studio
- Starting out: Starting a New Project — Four ways to start a project: Quick Create, AI Guided, Advanced Mode and Import from ZIP. Which one suits you, and why simpler project types show three.
- Starting out: Your Projects List — The sidebar, finding a project again, and the defaults every new project starts with.
- Starting out: Project Settings — The gear icon in the Code Studio: per-project AI model and rules, build tool, Java and Minecraft version, publishing and connectors, by project type.
- Starting out: Editor & Themes — Set up the Code Studio editor your way: Monaco or the Simple Editor, font, size, tab width, word wrap and minimap, plus Dark, Light and High Contrast.
14 of 37 in Code Studio (IDE) · Last checked 18 September 2026 · Previous: The Visual Editor