devportal
JBake
Our great sponsors
devportal | JBake | |
---|---|---|
3 | 3 | |
59 | 1,092 | |
- | 0.0% | |
9.5 | 1.1 | |
3 months ago | about 1 year ago | |
PLpgSQL | Java | |
Creative Commons Attribution 4.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
devportal
-
Migrating to Docusaurus
Hello folks, I am running a tech writing team (along with product management). I am not expert in documentation platforms. Today we have a challenging custom-built documentation platform based on Sphinx and a bunch of cobbled together technologies aiven/devportal: Resources for users of the projects on the Aiven platform (github.com) . Our documentation is in .rst markup language due to the Python focus.
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Humble brag that the last one in the list (Aiven 🦀) won 2022 DevPortal Awards in the category Best DevPortal Beyond REST Platforms. If I added a list of great docs websites but didn't include the OG, it would be a crime. Check out one of THE BEST documentation out there - Stripe Docs, built using Markdoc.
-
Automatically Open Pull Requests with GitHub Actions
You can find a list of Aiven's cloud providers on [Developer.aiven.io], which is also the portal where we host the developer documentation. To quickly retrieve a list of currently-available cloud providers, my colleague Lorna Mitchell wrote a Python script that pulls our cloud listing from the Aiven API and generates documentation, which is really cool!
JBake
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
An implementation of the docs-as-code approach, docToolchain is a collection of scripts that makes it easy to create and maintain powerful technical documentation. It is a popular open-source project that uses jBake under the hood as the SSG. docToolchain can publish to Confluence, generate PDF using an Asciidoctor plugin, and more.
- JBake is a Java based, open source, static site/blog generator
-
Can I run FreeMarker locally without a lot of setup?
What immediately springs to mind is JBake (https://jbake.org/) which is a Java static site generator that supports FreeMarker templates (and you can install it with sdkman).
What are some alternatives?
markdown-live-preview - markdown editor with live preview
Hugo - The world’s fastest framework for building websites.
pandoc-action-example - using the pandoc document converter on GitHub Actions
OpenRefine - OpenRefine is a free, open source power tool for working with messy data and improving it
antora
Lanterna - Java library for creating text-based GUIs
Docusaurus - Easy to maintain open source documentation websites.
Orchid - Build and deploy beautiful documentation sites that grow with you
create-pull-request - A GitHub action to create a pull request for changes to your repository in the actions workspace
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
jekyll-multiple-languages-plugin - I18n support for Jekyll and Octopress
Smooks - Extensible data integration Java framework for building XML and non-XML fragment-based applications