Having @open-sauced docs built using Docusaurus, we started exploring the plugin ecosystem and identified various improvements we could apply.
One of the community plugins we found during that process was signcl/docusaurus-prince-pdf, an npm package leveraging sindresorhus/got to crawl all the documentation and generate a PDF version.
Having a portable document generated as a downloadable release asset, we could more easily share the entirety of our docs and have that document available for offline use.
We faced the challenge of having to access the upcoming version during the deployment workflow, installing additional binaries, and deploying the generated asset as part of the release.
In order to generate a handbook out of a Docusaurus instance we need to build the application in a container before uploading it as a build artifact for later workflow steps.
This is all taken care of in the new docker job that was created for the hackaton:
Concurrently, the build job prepares static npm assets and uploads them as an artifact for a subsequent job:
jobs:build:name:Build applicationruns-on:ubuntu-lateststeps:-name:"☁️checkoutrepository"uses:actions/checkout@v2-name:"🔧setupnode"uses:actions/setup-node@v2.1.5with:node-version:16-name:"🔧installnpm@latest"run:npm i -g npm@latest-name:"📦installdependencies"uses:bahmutov/npm-install@v1-name:"🚀staticapp"run:npm run build-name:"📂productionartifacts"uses:actions/upload-artifact@v2with:name:buildpath:build
Docs dot Open Sauced is an static rendered documentation for open source developer onboarding
🍕 Open Sauced Docs 🍕
The path to your next Open Source contribution
🧪 Built for Experimenting
This tool is meant to accelerate development on Open Sauced by giving contributors a way to access Docusaurus 2 powered developer documentation available at docs.opensauced.pizza.
🤝 Contributing
We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.
🖥️ Development
npm ci
npm start
🍕 Community
Got Questions? Join the conversation in our Discord.
Find Open Sauced videos and release overviews on our YouTube Channel.