Greetings,
This one has been highly requested for a long time, and it's finally here!
You can now override the README and CHANGELOG shown on your package page, without uploading a new version.
This article covers:
What's new
When you update your mod
New to Markdown?
Small fixes
What's new
For those of you who have uploaded a README or CHANGELOG with a typo, you'd know that to fix it you'd have had to reupload the fixed version and would have had to bump the package version number. Thankfully, not anymore.
You'll find it behind the "Edit" button on your package page.
Overrides are saved on our end, not inside your package, so the downloaded files stay exactly as you uploaded them.
When a README or CHANGELOG has been overwritten, the page shows an "Edited" label with the date, so people know it differs from the uploaded file.
In the editor
Live preview while you write
Load an existing .md file instead of starting from scratch
README and CHANGELOG have their own tabs, and each one is saved separately
Changed your mind? "Discard site edit" brings back the file from your package
README Editing
CHANGELOG Editing
Changes can take a few minutes to show up for everyone else, so no need to panic if they don't appear right away.
When you update your mod
If your current version has an edited README, the upload page will let you know. You can then carry it over to the new version, or download it and add it to your package yourself. No more copy pasting between versions (unless you really enjoy that).
The new version uses the README in your package unless you turn on "Copy edited README".
CHANGELOG edits stay with the version you made them on and don't carry over. After the upload you'll get a button to download the edited CHANGELOG, so you can add it to your updated package.
New to Markdown?
READMEs and CHANGELOGs are written in Markdown. If headers, lists and such still feel like a mystery, we put together a short guide to get you going:
Small fixes
Alongside the editor, here are a few smaller things we've published lately:
Fixed uploads sometimes showing an error even though the upload went through fine
If you open the upload page from a community, that community is already picked for you
Category pickers are now sorted, and categories show in the same order everywhere on the site
Manifest validator error messages are readable again
The Install button only shows up on communities our mod manager supports, and it's gone from the versions list
Thanks
We'd like to thank everyone who asked for this and shared their thoughts.
This is the first iteration of the feature, and we'll be improving it based on your feedback. Have ideas or found a bug? Let us know on our Discord server!
Also if you'd like to get notified about new posts via email, you can subscribe to our mailing list here.
