August 21, 2015

The Perforce Workshop Says Hello Markdown, Goodbye Wiki

What's New
Community
Helix Swarm

Many moons ago, we set up a Mediawiki installation to provide a home page for projects in what was then called "The Public Depot." It did the trick, but it was always a bit odd having the documentation separate from the source code.

Thankfully, as of a couple of months ago you can now submit documentation in Markdown format and have it rendered in the Workshop. Simply submit the files with one of the following extensions:

  • markdown
  • mdown
  • mkdn
  • md
  • mkd
  • mdwn
  • mdtxt
  • mdtext

If you contribute to one of the projects, you can submit a file named "README.md" to the main branch to have the file displayed in the overview of the project page.

The Markdown support is an extension to Swarm, which is self-hosted in the Workshop in case you want to install it in your Swarm server:

http://swarm.workshop.perforce.com/projects/perforce-software-workshop

Note that this is a community extension and not officially supported by Perforce technical support.

Since we now have Markdown rendering within Swarm, we have migrated all of our wiki pages to the Workshop so the documentation stays with the project in one place. The wiki will be shutdown after September 1st.

Following the tradition of "Version Everything," we have archived the raw wiki source in the Workshop for future reference:

https://swarm.workshop.perforce.com/files/guest/lester_cheung/wiki-archive/mediawiki

The community development team is working to bring you even more features in the future. Stay tuned for more updates as they happen.