Your users care about two things in your content: can they find it fast and is it helpful?
Beyond that, everything comes in second place. People are rightfully fed up with labyrinthine documentation portals full of convoluted content navigation, dead ends, and unhelpful answers.
You’ve got a chance to step up your knowledge and reference content game with a simple, elegant, and fast documentation site that spares users the fluff and gets right to the point — answering questions!
And you can do it with our new Connector for Docusaurus.
What’s Docusaurus? 🦕
Docusaurus is an open-source static site generator. With our Connector for Docusaurus, your content in easyDITA can be transformed into a beautiful static documentation site in minutes. You can learn more about Docusaurus here: https://docusaurus.io/docs
What’s a Static Site Generator?
A static site generator (SSG) is a straightforward way to take your easyDITA content, merge it with a design template, and publish it as an HTML website. Write and order your content in our authoring environment, then, when it’s publishing time, Docusaurus combines your content with premade design templates to hand you a full static website that’s ready to host in mere minutes.
How Does It Work With easyDITA?
It’s pretty straightforward. Starting in easyDITA, you want to have access to your content library and know what DITA map you want to publish as a static site.
Once you’ve opened the DITA map you want to publish via Docusaurus, click the Publish button.
You’ll see the publishing screen, where you’ll need to select the Docusaurus Publishing menu option.
The next screen lays out a few options. For this example, we’re going to simply download our Docusaurus site as a .zip file.
Note: The Deploy to Netlify checkbox works with the Netlify web hosting service we often use to see real HTML examples of what our static site will look and operate like. There’s an in-depth walkthrough on how that works at the bottom of this page. Click here to jump there.
Select a template from the Template drop-down menu, then click Publish. Make sure the Navigate to output list box is checked so you can keep tabs on download progress. The screen will show output history and you can download the completed .zip files from there. But, we’re going to click on the Job number to open another window.
Opening via the job number allows you to see a few output details. You’ll see your key assets broken into two different files. Clicking the Download button will download every key asset.
You’ll notice two .zip files:
- build.zip — Great for previewing your Docusaurus static site locally or deploying it via your organization’s preferred hosting service.
- full_project.zip — Great to have if you plan to develop your own custom Docusaurus templates. For more on template development, see our documentation: Develop a Docusaurus Template
After this, your content is in your hands, ready to deploy via the hosting service of your choosing. For more detailed information about Docusaurus publishing, see our documentation: Docusaurus Publishing Guide